Properties
/api/v1/article Items
/api/v1/article Items : { get : { parameters : { query : { articleNumber ?: null | string ; articleNumbers ?: null | string [] ; articleSystemIdFrom ?: null | number ; goodsOwnerId : number ; locationNames ?: null | string [] ; maxArticlesToGet ?: null | number ; } ; } ; responses : { 200 : { content : { application/json : null | { articleNumber ?: null | string ; articleSystemId ?: number ; items ?: null | { batch ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; inDate ?: string ; isLocked ?: boolean ; isLockedForSale ?: boolean ; location ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; status ?: { code ?: null | string ; name ?: null | string ; } ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } [] ; } [] ; } ; } ; } ; } ; }
Type declaration
get : { parameters : { query : { articleNumber ?: null | string ; articleNumbers ?: null | string [] ; articleSystemIdFrom ?: null | number ; goodsOwnerId : number ; locationNames ?: null | string [] ; maxArticlesToGet ?: null | number ; } ; } ; responses : { 200 : { content : { application/json : null | { articleNumber ?: null | string ; articleSystemId ?: number ; items ?: null | { batch ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; inDate ?: string ; isLocked ?: boolean ; isLockedForSale ?: boolean ; location ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; status ?: { code ?: null | string ; name ?: null | string ; } ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } [] ; } [] ; } ; } ; } ; }
parameters : { query : { articleNumber ?: null | string ; articleNumbers ?: null | string [] ; articleSystemIdFrom ?: null | number ; goodsOwnerId : number ; locationNames ?: null | string [] ; maxArticlesToGet ?: null | number ; } ; }
query : { articleNumber ?: null | string ; articleNumbers ?: null | string [] ; articleSystemIdFrom ?: null | number ; goodsOwnerId : number ; locationNames ?: null | string [] ; maxArticlesToGet ?: null | number ; }
Optional article Number ?: null | string
Optional article Numbers ?: null | string []
Optional article System Id From ?: null | number
goods Owner Id : number
Optional location Names ?: null | string []
Optional max Articles To Get ?: null | number
responses : { 200 : { content : { application/json : null | { articleNumber ?: null | string ; articleSystemId ?: number ; items ?: null | { batch ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; inDate ?: string ; isLocked ?: boolean ; isLockedForSale ?: boolean ; location ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; status ?: { code ?: null | string ; name ?: null | string ; } ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } [] ; } [] ; } ; } ; }
200 : { content : { application/json : null | { articleNumber ?: null | string ; articleSystemId ?: number ; items ?: null | { batch ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; inDate ?: string ; isLocked ?: boolean ; isLockedForSale ?: boolean ; location ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; status ?: { code ?: null | string ; name ?: null | string ; } ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } [] ; } [] ; } ; }
content : { application/json : null | { articleNumber ?: null | string ; articleSystemId ?: number ; items ?: null | { batch ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; inDate ?: string ; isLocked ?: boolean ; isLockedForSale ?: boolean ; location ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; status ?: { code ?: null | string ; name ?: null | string ; } ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } [] ; } [] ; }
application/json : null | { articleNumber ?: null | string ; articleSystemId ?: number ; items ?: null | { batch ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; inDate ?: string ; isLocked ?: boolean ; isLockedForSale ?: boolean ; location ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; status ?: { code ?: null | string ; name ?: null | string ; } ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } [] ; } []
/api/v1/article Items/statuses
/api/v1/article Items/statuses : { get : { parameters : { query : { goodsOwnerId : number ; } ; } ; responses : { 200 : { content : { application/json : { articleItemStatuses ?: null | { code ?: null | string ; id ?: number ; isLocked ?: boolean ; isLockedForSale ?: boolean ; name ?: null | string ; } [] ; } ; } ; } ; } ; } ; }
Type declaration
get : { parameters : { query : { goodsOwnerId : number ; } ; } ; responses : { 200 : { content : { application/json : { articleItemStatuses ?: null | { code ?: null | string ; id ?: number ; isLocked ?: boolean ; isLockedForSale ?: boolean ; name ?: null | string ; } [] ; } ; } ; } ; } ; }
parameters : { query : { goodsOwnerId : number ; } ; }
query : { goodsOwnerId : number ; }
responses : { 200 : { content : { application/json : { articleItemStatuses ?: null | { code ?: null | string ; id ?: number ; isLocked ?: boolean ; isLockedForSale ?: boolean ; name ?: null | string ; } [] ; } ; } ; } ; }
200 : { content : { application/json : { articleItemStatuses ?: null | { code ?: null | string ; id ?: number ; isLocked ?: boolean ; isLockedForSale ?: boolean ; name ?: null | string ; } [] ; } ; } ; }
content : { application/json : { articleItemStatuses ?: null | { code ?: null | string ; id ?: number ; isLocked ?: boolean ; isLockedForSale ?: boolean ; name ?: null | string ; } [] ; } ; }
application/json : { articleItemStatuses ?: null | { code ?: null | string ; id ?: number ; isLocked ?: boolean ; isLockedForSale ?: boolean ; name ?: null | string ; } [] ; }
Optional article Item Statuses ?: null | { code ?: null | string ; id ?: number ; isLocked ?: boolean ; isLockedForSale ?: boolean ; name ?: null | string ; } []
/api/v1/articles
/api/v1/articles : { get : { parameters : { query : { articleClassIds ?: null | number [] ; articleDataLastUpdatedFrom ?: null | string ; articleNameContains ?: null | string [] ; articleNumber ?: null | string ; articleNumbers ?: null | string [] ; articleSystemIdFrom ?: null | number ; barCodes ?: null | string [] ; goodsOwnerId : number ; maxArticlesToGet ?: null | number ; onlyArticlesBelowStockLimit ?: null | boolean ; onlyArticlesBelowStockLimitConsideringNumberOfBookedItems ?: null | boolean ; onlyArticlesInStock ?: null | boolean ; productCode ?: null | string ; productCodes ?: null | string [] ; stockInfoChangedFrom ?: null | string ; } ; } ; responses : { 200 : { content : { application/json : null | { articleCategory ?: { code ?: null | string ; name ?: null | string ; } ; articleDataLastUpdated ?: null | string ; articleGroup ?: { code ?: null | string ; name ?: null | string ; } ; articleKind ?: null | string ; articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; barCodeInfo ?: { alternativeBarCodes ?: null | { barCode ?: null | string ; barCodeType ?: { code ?: null | string ; name ?: null | string ; } ; quantityPerBarCode ?: null | number ; } [] ; barCode ?: null | string ; barCodePackage ?: null | string ; barCodePallet ?: null | string ; } ; classes ?: null | { code ?: null | string ; id ?: number ; name ?: null | string ; } [] ; countryOfOriginCode ?: null | string ; customerPrice ?: null | number ; customsDescription ?: null | string ; defaultLocation ?: { name ?: null | string ; } ; defaultLocationMaxNumberOfItems ?: null | number ; defaultLocationStockLimit ?: null | number ; description ?: null | string ; freeValues ?: { freeBoolean1 ?: boolean ; freeBoolean2 ?: boolean ; freeBoolean3 ?: boolean ; freeDecimal1 ?: null | number ; freeDecimal2 ?: null | number ; freeDecimal3 ?: null | number ; } ; goodsOwner ?: { id ?: number ; name ?: null | string ; } ; height ?: null | number ; inventoryInfo ?: { allocatedNumberOfItems ?: number ; lastInDate ?: null | string ; lockedForSaleNumberOfItems ?: number ; numberOfBookedItems ?: number ; numberOfItems ?: number ; numberOfLockedItems ?: number ; pickedToBeCollectedNumberOfItems ?: number ; receivedToBeFinishedNumberOfItems ?: number ; sellableNumberOfItems ?: number ; toReceiveNumberOfItems ?: number ; totalStockValue ?: number ; } ; isActive ?: null | boolean ; isStockArticle ?: null | boolean ; length ?: null | number ; linkToPicture ?: null | string ; minimumReorderQuantity ?: null | number ; netWeight ?: null | number ; productCode ?: null | string ; purcaseCurrencyCode ?: null | string ; purchasePrice ?: null | number ; quantityPerPackage ?: null | number ; quantityPerPallet ?: null | number ; statisticsNumber ?: null | string ; stockLimit ?: null | number ; stockValuationPrice ?: null | number ; storageProperties ?: { isObsolete ?: boolean ; } ; subQuantityPerItem ?: null | number ; supplierInfo ?: { alternativeSuppliers ?: null | { supplierArticleNumber ?: null | string ; supplierName ?: null | string ; supplierNumber ?: null | string ; } [] ; supplierArticleNumber ?: null | string ; supplierName ?: null | string ; supplierNumber ?: null | string ; } ; taricNumbersInfo ?: { taricNumbers ?: null | { countryCode ?: null | string ; taricNumber ?: null | string ; } [] ; } ; unitCode ?: null | string ; volume ?: null | number ; weight ?: null | number ; width ?: null | number ; } [] ; } ; } ; } ; } ; put : { requestBody : { content : { application/json : { articleCategory ?: { code ?: null | string ; name ?: null | string ; } ; articleColor ?: { code ?: null | string ; name ?: null | string ; } ; articleGroup ?: { code ?: null | string ; name ?: null | string ; } ; articleName ?: null | string ; articleNameTranslations ?: null | { articleName ?: null | string ; languageCode ?: null | string ; } [] ; articleNumber : string ; articleSize ?: { code ?: null | string ; name ?: null | string ; } ; barCodeInfo ?: { alternativeBarCodes ?: null | { barCode ?: null | string ; barCodeType ?: { code ?: null | string ; name ?: null | string ; } ; quantityPerBarCode ?: null | number ; } [] ; barCode ?: null | string ; barCodePackage ?: null | string ; barCodePallet ?: null | string ; } ; countryOfOriginCode ?: null | string ; customerPrice ?: null | number ; customsDescription ?: null | string ; description ?: null | string ; freeValues ?: { freeBoolean1 ?: null | boolean ; freeBoolean2 ?: null | boolean ; freeBoolean3 ?: null | boolean ; freeDecimal1 ?: null | number ; freeDecimal2 ?: null | number ; freeDecimal3 ?: null | number ; } ; goodsOwnerId : number ; height ?: null | number ; isActive ?: null | boolean ; isStockArticle ?: null | boolean ; length ?: null | number ; linkToPicture ?: null | string ; minDaysToExpiryDateAllowedOnDelivery ?: null | number ; minimumReorderQuantity ?: null | number ; netWeight ?: null | number ; productCode ?: null | string ; purcaseCurrencyCode ?: null | string ; purchasePrice ?: null | number ; quantityPerLayerOnPallet ?: null | number ; quantityPerPackage ?: null | number ; quantityPerPallet ?: null | number ; statisticsNumber ?: null | string ; stockLimit ?: null | number ; stockValuationPrice ?: null | number ; storageClass ?: { name : string ; } ; storageProperties ?: { isBatchArticle ?: null | boolean ; isExpiryDateArticle ?: null | boolean ; isObsolete ?: null | boolean ; isSerialNumberArticle ?: null | boolean ; } ; structureDefinition ?: { articleKind ?: "Structure" | "Production" ; rows ?: null | { articleNumber : string ; numberOfItems ?: number ; } [] ; } ; subQuantityPerItem ?: null | number ; supplierInfo ?: { supplierArticleNumber ?: null | string ; supplierName ?: null | string ; supplierNumber ?: null | string ; } ; taricNumbersInfo ?: { taricNumbers ?: null | { countryCode : string ; taricNumber : string ; } [] ; } ; unitCode ?: null | string ; volume ?: null | number ; weight ?: null | number ; width ?: null | number ; } ; } ; } ; responses : { 200 : { content : { application/json : { articleSystemId ?: null | number ; message ?: null | string ; } ; } ; } ; } ; } ; }
/api/v1/articles/classes
/api/v1/articles/classes : { get : { parameters : { query : { goodsOwnerId : number ; } ; } ; responses : { 200 : { content : { application/json : { articleClasses ?: null | { code ?: null | string ; comment ?: null | string ; id ?: number ; name ?: null | string ; } [] ; } ; } ; } ; } ; } ; put : { requestBody : { content : { application/json : { code : string ; comment ?: null | string ; goodsOwnerId : number ; name : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { articleClassId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; } ; }
Type declaration
get : { parameters : { query : { goodsOwnerId : number ; } ; } ; responses : { 200 : { content : { application/json : { articleClasses ?: null | { code ?: null | string ; comment ?: null | string ; id ?: number ; name ?: null | string ; } [] ; } ; } ; } ; } ; }
parameters : { query : { goodsOwnerId : number ; } ; }
query : { goodsOwnerId : number ; }
responses : { 200 : { content : { application/json : { articleClasses ?: null | { code ?: null | string ; comment ?: null | string ; id ?: number ; name ?: null | string ; } [] ; } ; } ; } ; }
200 : { content : { application/json : { articleClasses ?: null | { code ?: null | string ; comment ?: null | string ; id ?: number ; name ?: null | string ; } [] ; } ; } ; }
content : { application/json : { articleClasses ?: null | { code ?: null | string ; comment ?: null | string ; id ?: number ; name ?: null | string ; } [] ; } ; }
application/json : { articleClasses ?: null | { code ?: null | string ; comment ?: null | string ; id ?: number ; name ?: null | string ; } [] ; }
Optional article Classes ?: null | { code ?: null | string ; comment ?: null | string ; id ?: number ; name ?: null | string ; } []
put : { requestBody : { content : { application/json : { code : string ; comment ?: null | string ; goodsOwnerId : number ; name : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { articleClassId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; }
request Body : { content : { application/json : { code : string ; comment ?: null | string ; goodsOwnerId : number ; name : string ; } ; } ; }
content : { application/json : { code : string ; comment ?: null | string ; goodsOwnerId : number ; name : string ; } ; }
application/json : { code : string ; comment ?: null | string ; goodsOwnerId : number ; name : string ; }
code : string
Optional comment ?: null | string
goods Owner Id : number
name : string
responses : { 200 : { content : { application/json : { articleClassId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; }
200 : { content : { application/json : { articleClassId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; }
content : { application/json : { articleClassId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; }
application/json : { articleClassId ?: null | number ; message ?: null | string ; success ?: boolean ; }
Optional article Class Id ?: null | number
Optional message ?: null | string
Optional success ?: boolean
/api/v1/articles/classes/{article Class Id}
/api/v1/articles/classes/{article Class Id} : { delete : { parameters : { path : { articleClassId : number ; } ; } ; responses : { 200 : { content : { application/json : { articleClassId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; } ; put : { parameters : { path : { articleClassId : number ; } ; } ; requestBody : { content : { application/json : { code : string ; comment ?: null | string ; goodsOwnerId : number ; name : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { articleClassId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; } ; }
Type declaration
delete : { parameters : { path : { articleClassId : number ; } ; } ; responses : { 200 : { content : { application/json : { articleClassId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; }
parameters : { path : { articleClassId : number ; } ; }
path : { articleClassId : number ; }
responses : { 200 : { content : { application/json : { articleClassId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; }
200 : { content : { application/json : { articleClassId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; }
content : { application/json : { articleClassId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; }
application/json : { articleClassId ?: null | number ; message ?: null | string ; success ?: boolean ; }
Optional article Class Id ?: null | number
Optional message ?: null | string
Optional success ?: boolean
put : { parameters : { path : { articleClassId : number ; } ; } ; requestBody : { content : { application/json : { code : string ; comment ?: null | string ; goodsOwnerId : number ; name : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { articleClassId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; }
parameters : { path : { articleClassId : number ; } ; }
path : { articleClassId : number ; }
request Body : { content : { application/json : { code : string ; comment ?: null | string ; goodsOwnerId : number ; name : string ; } ; } ; }
content : { application/json : { code : string ; comment ?: null | string ; goodsOwnerId : number ; name : string ; } ; }
application/json : { code : string ; comment ?: null | string ; goodsOwnerId : number ; name : string ; }
code : string
Optional comment ?: null | string
goods Owner Id : number
name : string
responses : { 200 : { content : { application/json : { articleClassId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; }
200 : { content : { application/json : { articleClassId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; }
content : { application/json : { articleClassId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; }
application/json : { articleClassId ?: null | number ; message ?: null | string ; success ?: boolean ; }
Optional article Class Id ?: null | number
Optional message ?: null | string
Optional success ?: boolean
/api/v1/articles/dangerous Goods
/api/v1/articles/dangerous Goods : { get : { parameters : { query : { articleNumbers ?: null | string [] ; goodsOwnerId : number ; } ; } ; responses : { 200 : { content : { application/json : { articleNumber ?: null | string ; articleSystemId ?: number ; dangerousGoods ?: { dangerousGoodsCoefficient ?: null | number ; emsCode ?: null | string ; unIsMarineHazard ?: boolean ; unLabelNumbers ?: null | string ; unNumber ?: { unClassNumber ?: null | string ; unNumber ?: null | string ; unTunnelCodes ?: null | { unTunnelCode ?: null | string ; } [] ; } ; unPackageType ?: null | string ; unProperShippingNames ?: null | { languageCode ?: null | string ; name ?: null | string ; } [] ; } ; } [] ; } ; } ; } ; } ; put : { requestBody : { content : { application/json : { articleNumber : string ; dangerousGoods : { dangerousGoodsCoefficient ?: null | number ; emsCode ?: null | string ; unIsMarineHazard ?: boolean ; unLabelNumbers ?: null | string ; unNumber : string ; unPackageType ?: null | string ; unProperShippingNames ?: null | { languageCode ?: null | string ; name ?: null | string ; } [] ; } ; goodsOwnerId : number ; } ; } ; } ; responses : { 200 : { content : { application/json : { articleSystemId ?: null | number ; message ?: null | string ; } ; } ; } ; } ; } ; }
Type declaration
get : { parameters : { query : { articleNumbers ?: null | string [] ; goodsOwnerId : number ; } ; } ; responses : { 200 : { content : { application/json : { articleNumber ?: null | string ; articleSystemId ?: number ; dangerousGoods ?: { dangerousGoodsCoefficient ?: null | number ; emsCode ?: null | string ; unIsMarineHazard ?: boolean ; unLabelNumbers ?: null | string ; unNumber ?: { unClassNumber ?: null | string ; unNumber ?: null | string ; unTunnelCodes ?: null | { unTunnelCode ?: null | string ; } [] ; } ; unPackageType ?: null | string ; unProperShippingNames ?: null | { languageCode ?: null | string ; name ?: null | string ; } [] ; } ; } [] ; } ; } ; } ; }
parameters : { query : { articleNumbers ?: null | string [] ; goodsOwnerId : number ; } ; }
query : { articleNumbers ?: null | string [] ; goodsOwnerId : number ; }
Optional article Numbers ?: null | string []
goods Owner Id : number
responses : { 200 : { content : { application/json : { articleNumber ?: null | string ; articleSystemId ?: number ; dangerousGoods ?: { dangerousGoodsCoefficient ?: null | number ; emsCode ?: null | string ; unIsMarineHazard ?: boolean ; unLabelNumbers ?: null | string ; unNumber ?: { unClassNumber ?: null | string ; unNumber ?: null | string ; unTunnelCodes ?: null | { unTunnelCode ?: null | string ; } [] ; } ; unPackageType ?: null | string ; unProperShippingNames ?: null | { languageCode ?: null | string ; name ?: null | string ; } [] ; } ; } [] ; } ; } ; }
200 : { content : { application/json : { articleNumber ?: null | string ; articleSystemId ?: number ; dangerousGoods ?: { dangerousGoodsCoefficient ?: null | number ; emsCode ?: null | string ; unIsMarineHazard ?: boolean ; unLabelNumbers ?: null | string ; unNumber ?: { unClassNumber ?: null | string ; unNumber ?: null | string ; unTunnelCodes ?: null | { unTunnelCode ?: null | string ; } [] ; } ; unPackageType ?: null | string ; unProperShippingNames ?: null | { languageCode ?: null | string ; name ?: null | string ; } [] ; } ; } [] ; } ; }
content : { application/json : { articleNumber ?: null | string ; articleSystemId ?: number ; dangerousGoods ?: { dangerousGoodsCoefficient ?: null | number ; emsCode ?: null | string ; unIsMarineHazard ?: boolean ; unLabelNumbers ?: null | string ; unNumber ?: { unClassNumber ?: null | string ; unNumber ?: null | string ; unTunnelCodes ?: null | { unTunnelCode ?: null | string ; } [] ; } ; unPackageType ?: null | string ; unProperShippingNames ?: null | { languageCode ?: null | string ; name ?: null | string ; } [] ; } ; } [] ; }
application/json : { articleNumber ?: null | string ; articleSystemId ?: number ; dangerousGoods ?: { dangerousGoodsCoefficient ?: null | number ; emsCode ?: null | string ; unIsMarineHazard ?: boolean ; unLabelNumbers ?: null | string ; unNumber ?: { unClassNumber ?: null | string ; unNumber ?: null | string ; unTunnelCodes ?: null | { unTunnelCode ?: null | string ; } [] ; } ; unPackageType ?: null | string ; unProperShippingNames ?: null | { languageCode ?: null | string ; name ?: null | string ; } [] ; } ; } []
put : { requestBody : { content : { application/json : { articleNumber : string ; dangerousGoods : { dangerousGoodsCoefficient ?: null | number ; emsCode ?: null | string ; unIsMarineHazard ?: boolean ; unLabelNumbers ?: null | string ; unNumber : string ; unPackageType ?: null | string ; unProperShippingNames ?: null | { languageCode ?: null | string ; name ?: null | string ; } [] ; } ; goodsOwnerId : number ; } ; } ; } ; responses : { 200 : { content : { application/json : { articleSystemId ?: null | number ; message ?: null | string ; } ; } ; } ; } ; }
request Body : { content : { application/json : { articleNumber : string ; dangerousGoods : { dangerousGoodsCoefficient ?: null | number ; emsCode ?: null | string ; unIsMarineHazard ?: boolean ; unLabelNumbers ?: null | string ; unNumber : string ; unPackageType ?: null | string ; unProperShippingNames ?: null | { languageCode ?: null | string ; name ?: null | string ; } [] ; } ; goodsOwnerId : number ; } ; } ; }
content : { application/json : { articleNumber : string ; dangerousGoods : { dangerousGoodsCoefficient ?: null | number ; emsCode ?: null | string ; unIsMarineHazard ?: boolean ; unLabelNumbers ?: null | string ; unNumber : string ; unPackageType ?: null | string ; unProperShippingNames ?: null | { languageCode ?: null | string ; name ?: null | string ; } [] ; } ; goodsOwnerId : number ; } ; }
application/json : { articleNumber : string ; dangerousGoods : { dangerousGoodsCoefficient ?: null | number ; emsCode ?: null | string ; unIsMarineHazard ?: boolean ; unLabelNumbers ?: null | string ; unNumber : string ; unPackageType ?: null | string ; unProperShippingNames ?: null | { languageCode ?: null | string ; name ?: null | string ; } [] ; } ; goodsOwnerId : number ; }
article Number : string
dangerous Goods : { dangerousGoodsCoefficient ?: null | number ; emsCode ?: null | string ; unIsMarineHazard ?: boolean ; unLabelNumbers ?: null | string ; unNumber : string ; unPackageType ?: null | string ; unProperShippingNames ?: null | { languageCode ?: null | string ; name ?: null | string ; } [] ; }
Optional dangerous Goods Coefficient ?: null | number
Optional ems Code ?: null | string
Optional un Is Marine Hazard ?: boolean
Optional un Label Numbers ?: null | string
un Number : string
Optional un Package Type ?: null | string
Optional un Proper Shipping Names ?: null | { languageCode ?: null | string ; name ?: null | string ; } []
goods Owner Id : number
responses : { 200 : { content : { application/json : { articleSystemId ?: null | number ; message ?: null | string ; } ; } ; } ; }
200 : { content : { application/json : { articleSystemId ?: null | number ; message ?: null | string ; } ; } ; }
content : { application/json : { articleSystemId ?: null | number ; message ?: null | string ; } ; }
application/json : { articleSystemId ?: null | number ; message ?: null | string ; }
Optional article System Id ?: null | number
Optional message ?: null | string
/api/v1/articles/historical Inventory
/api/v1/articles/historical Inventory : { get : { parameters : { query : { goodsOwnerId : number ; stockDate : string ; warehouseId ?: null | number ; } ; } ; responses : { 200 : { content : { application/json : { articles ?: null | { articleItems ?: null | { batch ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; } [] ; articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; numberOfItems ?: number ; productCode ?: null | string ; } [] ; } [] ; } ; } ; } ; } ; }
Type declaration
get : { parameters : { query : { goodsOwnerId : number ; stockDate : string ; warehouseId ?: null | number ; } ; } ; responses : { 200 : { content : { application/json : { articles ?: null | { articleItems ?: null | { batch ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; } [] ; articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; numberOfItems ?: number ; productCode ?: null | string ; } [] ; } [] ; } ; } ; } ; }
parameters : { query : { goodsOwnerId : number ; stockDate : string ; warehouseId ?: null | number ; } ; }
query : { goodsOwnerId : number ; stockDate : string ; warehouseId ?: null | number ; }
goods Owner Id : number
stock Date : string
Optional warehouse Id ?: null | number
responses : { 200 : { content : { application/json : { articles ?: null | { articleItems ?: null | { batch ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; } [] ; articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; numberOfItems ?: number ; productCode ?: null | string ; } [] ; } [] ; } ; } ; }
200 : { content : { application/json : { articles ?: null | { articleItems ?: null | { batch ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; } [] ; articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; numberOfItems ?: number ; productCode ?: null | string ; } [] ; } [] ; } ; }
content : { application/json : { articles ?: null | { articleItems ?: null | { batch ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; } [] ; articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; numberOfItems ?: number ; productCode ?: null | string ; } [] ; } [] ; }
application/json : { articles ?: null | { articleItems ?: null | { batch ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; } [] ; articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; numberOfItems ?: number ; productCode ?: null | string ; } [] ; } []
/api/v1/articles/inventory Per Warehouse
/api/v1/articles/inventory Per Warehouse : { get : { parameters : { query : { articleNumbers ?: null | string [] ; articleSystemIdFrom ?: null | number ; goodsOwnerId : number ; maxArticlesToGet ?: null | number ; onlyArticlesInStock ?: null | boolean ; stockInfoChangedFrom ?: null | string ; warehouseIds ?: null | number [] ; } ; } ; responses : { 200 : { content : { application/json : { articleNumber ?: null | string ; articleSystemId ?: number ; inventoryPerWarehouse ?: null | { availableForSaleNumberOfItems ?: number ; numberOfItems ?: number ; numberOfLockedItems ?: number ; reported ?: { pickedToBeReportedNumberOfItems ?: number ; receivedToBeReportedNumberOfItems ?: number ; returnedToBeReportedNumberOfItems ?: number ; } ; sellableNumberOfItems ?: number ; warehouseId ?: number ; } [] ; } [] ; } ; } ; } ; } ; }
Type declaration
get : { parameters : { query : { articleNumbers ?: null | string [] ; articleSystemIdFrom ?: null | number ; goodsOwnerId : number ; maxArticlesToGet ?: null | number ; onlyArticlesInStock ?: null | boolean ; stockInfoChangedFrom ?: null | string ; warehouseIds ?: null | number [] ; } ; } ; responses : { 200 : { content : { application/json : { articleNumber ?: null | string ; articleSystemId ?: number ; inventoryPerWarehouse ?: null | { availableForSaleNumberOfItems ?: number ; numberOfItems ?: number ; numberOfLockedItems ?: number ; reported ?: { pickedToBeReportedNumberOfItems ?: number ; receivedToBeReportedNumberOfItems ?: number ; returnedToBeReportedNumberOfItems ?: number ; } ; sellableNumberOfItems ?: number ; warehouseId ?: number ; } [] ; } [] ; } ; } ; } ; }
parameters : { query : { articleNumbers ?: null | string [] ; articleSystemIdFrom ?: null | number ; goodsOwnerId : number ; maxArticlesToGet ?: null | number ; onlyArticlesInStock ?: null | boolean ; stockInfoChangedFrom ?: null | string ; warehouseIds ?: null | number [] ; } ; }
query : { articleNumbers ?: null | string [] ; articleSystemIdFrom ?: null | number ; goodsOwnerId : number ; maxArticlesToGet ?: null | number ; onlyArticlesInStock ?: null | boolean ; stockInfoChangedFrom ?: null | string ; warehouseIds ?: null | number [] ; }
Optional article Numbers ?: null | string []
Optional article System Id From ?: null | number
goods Owner Id : number
Optional max Articles To Get ?: null | number
Optional only Articles In Stock ?: null | boolean
Optional stock Info Changed From ?: null | string
Optional warehouse Ids ?: null | number []
responses : { 200 : { content : { application/json : { articleNumber ?: null | string ; articleSystemId ?: number ; inventoryPerWarehouse ?: null | { availableForSaleNumberOfItems ?: number ; numberOfItems ?: number ; numberOfLockedItems ?: number ; reported ?: { pickedToBeReportedNumberOfItems ?: number ; receivedToBeReportedNumberOfItems ?: number ; returnedToBeReportedNumberOfItems ?: number ; } ; sellableNumberOfItems ?: number ; warehouseId ?: number ; } [] ; } [] ; } ; } ; }
200 : { content : { application/json : { articleNumber ?: null | string ; articleSystemId ?: number ; inventoryPerWarehouse ?: null | { availableForSaleNumberOfItems ?: number ; numberOfItems ?: number ; numberOfLockedItems ?: number ; reported ?: { pickedToBeReportedNumberOfItems ?: number ; receivedToBeReportedNumberOfItems ?: number ; returnedToBeReportedNumberOfItems ?: number ; } ; sellableNumberOfItems ?: number ; warehouseId ?: number ; } [] ; } [] ; } ; }
content : { application/json : { articleNumber ?: null | string ; articleSystemId ?: number ; inventoryPerWarehouse ?: null | { availableForSaleNumberOfItems ?: number ; numberOfItems ?: number ; numberOfLockedItems ?: number ; reported ?: { pickedToBeReportedNumberOfItems ?: number ; receivedToBeReportedNumberOfItems ?: number ; returnedToBeReportedNumberOfItems ?: number ; } ; sellableNumberOfItems ?: number ; warehouseId ?: number ; } [] ; } [] ; }
application/json : { articleNumber ?: null | string ; articleSystemId ?: number ; inventoryPerWarehouse ?: null | { availableForSaleNumberOfItems ?: number ; numberOfItems ?: number ; numberOfLockedItems ?: number ; reported ?: { pickedToBeReportedNumberOfItems ?: number ; receivedToBeReportedNumberOfItems ?: number ; returnedToBeReportedNumberOfItems ?: number ; } ; sellableNumberOfItems ?: number ; warehouseId ?: number ; } [] ; } []
/api/v1/articles/structure Definitions
/api/v1/articles/structure Definitions : { get : { parameters : { query : { articleKind : null | string ; articleNumbers ?: null | string [] ; goodsOwnerId : number ; } ; } ; responses : { 200 : { content : { application/json : { articleKind ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; rows ?: null | { articleNumber ?: null | string ; articleSystemId ?: number ; numberOfItems ?: null | number ; } [] ; } [] ; } ; } ; } ; } ; }
Type declaration
get : { parameters : { query : { articleKind : null | string ; articleNumbers ?: null | string [] ; goodsOwnerId : number ; } ; } ; responses : { 200 : { content : { application/json : { articleKind ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; rows ?: null | { articleNumber ?: null | string ; articleSystemId ?: number ; numberOfItems ?: null | number ; } [] ; } [] ; } ; } ; } ; }
parameters : { query : { articleKind : null | string ; articleNumbers ?: null | string [] ; goodsOwnerId : number ; } ; }
query : { articleKind : null | string ; articleNumbers ?: null | string [] ; goodsOwnerId : number ; }
article Kind : null | string
Optional article Numbers ?: null | string []
goods Owner Id : number
responses : { 200 : { content : { application/json : { articleKind ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; rows ?: null | { articleNumber ?: null | string ; articleSystemId ?: number ; numberOfItems ?: null | number ; } [] ; } [] ; } ; } ; }
200 : { content : { application/json : { articleKind ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; rows ?: null | { articleNumber ?: null | string ; articleSystemId ?: number ; numberOfItems ?: null | number ; } [] ; } [] ; } ; }
content : { application/json : { articleKind ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; rows ?: null | { articleNumber ?: null | string ; articleSystemId ?: number ; numberOfItems ?: null | number ; } [] ; } [] ; }
application/json : { articleKind ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; rows ?: null | { articleNumber ?: null | string ; articleSystemId ?: number ; numberOfItems ?: null | number ; } [] ; } []
/api/v1/articles/{article System Id}
/api/v1/articles/{article System Id} : { get : { parameters : { path : { articleSystemId : number ; } ; } ; responses : { 200 : { content : { application/json : { articleCategory ?: { code ?: null | string ; name ?: null | string ; } ; articleDataLastUpdated ?: null | string ; articleGroup ?: { code ?: null | string ; name ?: null | string ; } ; articleKind ?: null | string ; articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; barCodeInfo ?: { alternativeBarCodes ?: null | { barCode ?: null | string ; barCodeType ?: { code ?: null | string ; name ?: null | string ; } ; quantityPerBarCode ?: null | number ; } [] ; barCode ?: null | string ; barCodePackage ?: null | string ; barCodePallet ?: null | string ; } ; classes ?: null | { code ?: null | string ; id ?: number ; name ?: null | string ; } [] ; countryOfOriginCode ?: null | string ; customerPrice ?: null | number ; customsDescription ?: null | string ; defaultLocation ?: { name ?: null | string ; } ; defaultLocationMaxNumberOfItems ?: null | number ; defaultLocationStockLimit ?: null | number ; description ?: null | string ; freeValues ?: { freeBoolean1 ?: boolean ; freeBoolean2 ?: boolean ; freeBoolean3 ?: boolean ; freeDecimal1 ?: null | number ; freeDecimal2 ?: null | number ; freeDecimal3 ?: null | number ; } ; goodsOwner ?: { id ?: number ; name ?: null | string ; } ; height ?: null | number ; inventoryInfo ?: { allocatedNumberOfItems ?: number ; lastInDate ?: null | string ; lockedForSaleNumberOfItems ?: number ; numberOfBookedItems ?: number ; numberOfItems ?: number ; numberOfLockedItems ?: number ; pickedToBeCollectedNumberOfItems ?: number ; receivedToBeFinishedNumberOfItems ?: number ; sellableNumberOfItems ?: number ; toReceiveNumberOfItems ?: number ; totalStockValue ?: number ; } ; isActive ?: null | boolean ; isStockArticle ?: null | boolean ; length ?: null | number ; linkToPicture ?: null | string ; minimumReorderQuantity ?: null | number ; netWeight ?: null | number ; productCode ?: null | string ; purcaseCurrencyCode ?: null | string ; purchasePrice ?: null | number ; quantityPerPackage ?: null | number ; quantityPerPallet ?: null | number ; statisticsNumber ?: null | string ; stockLimit ?: null | number ; stockValuationPrice ?: null | number ; storageProperties ?: { isObsolete ?: boolean ; } ; subQuantityPerItem ?: null | number ; supplierInfo ?: { alternativeSuppliers ?: null | { supplierArticleNumber ?: null | string ; supplierName ?: null | string ; supplierNumber ?: null | string ; } [] ; supplierArticleNumber ?: null | string ; supplierName ?: null | string ; supplierNumber ?: null | string ; } ; taricNumbersInfo ?: { taricNumbers ?: null | { countryCode ?: null | string ; taricNumber ?: null | string ; } [] ; } ; unitCode ?: null | string ; volume ?: null | number ; weight ?: null | number ; width ?: null | number ; } ; } ; } ; } ; } ; put : { parameters : { path : { articleSystemId : number ; } ; } ; requestBody : { content : { application/json : { articleCategory ?: { code ?: null | string ; name ?: null | string ; } ; articleColor ?: { code ?: null | string ; name ?: null | string ; } ; articleGroup ?: { code ?: null | string ; name ?: null | string ; } ; articleName ?: null | string ; articleNameTranslations ?: null | { articleName ?: null | string ; languageCode ?: null | string ; } [] ; articleNumber : string ; articleSize ?: { code ?: null | string ; name ?: null | string ; } ; barCodeInfo ?: { alternativeBarCodes ?: null | { barCode ?: null | string ; barCodeType ?: { code ?: null | string ; name ?: null | string ; } ; quantityPerBarCode ?: null | number ; } [] ; barCode ?: null | string ; barCodePackage ?: null | string ; barCodePallet ?: null | string ; } ; countryOfOriginCode ?: null | string ; customerPrice ?: null | number ; customsDescription ?: null | string ; description ?: null | string ; freeValues ?: { freeBoolean1 ?: null | boolean ; freeBoolean2 ?: null | boolean ; freeBoolean3 ?: null | boolean ; freeDecimal1 ?: null | number ; freeDecimal2 ?: null | number ; freeDecimal3 ?: null | number ; } ; goodsOwnerId : number ; height ?: null | number ; isActive ?: null | boolean ; isStockArticle ?: null | boolean ; length ?: null | number ; linkToPicture ?: null | string ; minDaysToExpiryDateAllowedOnDelivery ?: null | number ; minimumReorderQuantity ?: null | number ; netWeight ?: null | number ; productCode ?: null | string ; purcaseCurrencyCode ?: null | string ; purchasePrice ?: null | number ; quantityPerLayerOnPallet ?: null | number ; quantityPerPackage ?: null | number ; quantityPerPallet ?: null | number ; statisticsNumber ?: null | string ; stockLimit ?: null | number ; stockValuationPrice ?: null | number ; storageClass ?: { name : string ; } ; storageProperties ?: { isBatchArticle ?: null | boolean ; isExpiryDateArticle ?: null | boolean ; isObsolete ?: null | boolean ; isSerialNumberArticle ?: null | boolean ; } ; structureDefinition ?: { articleKind ?: "Structure" | "Production" ; rows ?: null | { articleNumber : string ; numberOfItems ?: number ; } [] ; } ; subQuantityPerItem ?: null | number ; supplierInfo ?: { supplierArticleNumber ?: null | string ; supplierName ?: null | string ; supplierNumber ?: null | string ; } ; taricNumbersInfo ?: { taricNumbers ?: null | { countryCode : string ; taricNumber : string ; } [] ; } ; unitCode ?: null | string ; volume ?: null | number ; weight ?: null | number ; width ?: null | number ; } ; } ; } ; responses : { 200 : { content : { application/json : { articleSystemId ?: null | number ; message ?: null | string ; } ; } ; } ; } ; } ; }
/api/v1/articles/{article System Id}/classes
/api/v1/articles/{article System Id}/classes : { put : { parameters : { path : { articleSystemId : number ; } ; } ; requestBody : { content : { application/json : { articleClassIds : number [] ; } ; } ; } ; responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; } ; }
Type declaration
put : { parameters : { path : { articleSystemId : number ; } ; } ; requestBody : { content : { application/json : { articleClassIds : number [] ; } ; } ; } ; responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; }
parameters : { path : { articleSystemId : number ; } ; }
path : { articleSystemId : number ; }
request Body : { content : { application/json : { articleClassIds : number [] ; } ; } ; }
content : { application/json : { articleClassIds : number [] ; } ; }
application/json : { articleClassIds : number [] ; }
article Class Ids : number []
responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; }
200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; }
content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; }
application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; }
Optional file Id ?: null | number
Optional message ?: null | string
Optional success ?: boolean
/api/v1/articles/{article System Id}/dangerous Goods
/api/v1/articles/{article System Id}/dangerous Goods : { get : { parameters : { path : { articleSystemId : number ; } ; } ; responses : { 200 : { content : { application/json : { articleNumber ?: null | string ; articleSystemId ?: number ; dangerousGoods ?: { dangerousGoodsCoefficient ?: null | number ; emsCode ?: null | string ; unIsMarineHazard ?: boolean ; unLabelNumbers ?: null | string ; unNumber ?: { unClassNumber ?: null | string ; unNumber ?: null | string ; unTunnelCodes ?: null | { unTunnelCode ?: null | string ; } [] ; } ; unPackageType ?: null | string ; unProperShippingNames ?: null | { languageCode ?: null | string ; name ?: null | string ; } [] ; } ; } ; } ; } ; } ; } ; put : { parameters : { path : { articleSystemId : number ; } ; } ; requestBody : { content : { application/json : { dangerousGoodsCoefficient ?: null | number ; emsCode ?: null | string ; unIsMarineHazard ?: boolean ; unLabelNumbers ?: null | string ; unNumber : string ; unPackageType ?: null | string ; unProperShippingNames ?: null | { languageCode ?: null | string ; name ?: null | string ; } [] ; } ; } ; } ; responses : { 200 : { content : { application/json : { articleSystemId ?: null | number ; message ?: null | string ; } ; } ; } ; } ; } ; }
Type declaration
get : { parameters : { path : { articleSystemId : number ; } ; } ; responses : { 200 : { content : { application/json : { articleNumber ?: null | string ; articleSystemId ?: number ; dangerousGoods ?: { dangerousGoodsCoefficient ?: null | number ; emsCode ?: null | string ; unIsMarineHazard ?: boolean ; unLabelNumbers ?: null | string ; unNumber ?: { unClassNumber ?: null | string ; unNumber ?: null | string ; unTunnelCodes ?: null | { unTunnelCode ?: null | string ; } [] ; } ; unPackageType ?: null | string ; unProperShippingNames ?: null | { languageCode ?: null | string ; name ?: null | string ; } [] ; } ; } ; } ; } ; } ; }
parameters : { path : { articleSystemId : number ; } ; }
path : { articleSystemId : number ; }
responses : { 200 : { content : { application/json : { articleNumber ?: null | string ; articleSystemId ?: number ; dangerousGoods ?: { dangerousGoodsCoefficient ?: null | number ; emsCode ?: null | string ; unIsMarineHazard ?: boolean ; unLabelNumbers ?: null | string ; unNumber ?: { unClassNumber ?: null | string ; unNumber ?: null | string ; unTunnelCodes ?: null | { unTunnelCode ?: null | string ; } [] ; } ; unPackageType ?: null | string ; unProperShippingNames ?: null | { languageCode ?: null | string ; name ?: null | string ; } [] ; } ; } ; } ; } ; }
200 : { content : { application/json : { articleNumber ?: null | string ; articleSystemId ?: number ; dangerousGoods ?: { dangerousGoodsCoefficient ?: null | number ; emsCode ?: null | string ; unIsMarineHazard ?: boolean ; unLabelNumbers ?: null | string ; unNumber ?: { unClassNumber ?: null | string ; unNumber ?: null | string ; unTunnelCodes ?: null | { unTunnelCode ?: null | string ; } [] ; } ; unPackageType ?: null | string ; unProperShippingNames ?: null | { languageCode ?: null | string ; name ?: null | string ; } [] ; } ; } ; } ; }
content : { application/json : { articleNumber ?: null | string ; articleSystemId ?: number ; dangerousGoods ?: { dangerousGoodsCoefficient ?: null | number ; emsCode ?: null | string ; unIsMarineHazard ?: boolean ; unLabelNumbers ?: null | string ; unNumber ?: { unClassNumber ?: null | string ; unNumber ?: null | string ; unTunnelCodes ?: null | { unTunnelCode ?: null | string ; } [] ; } ; unPackageType ?: null | string ; unProperShippingNames ?: null | { languageCode ?: null | string ; name ?: null | string ; } [] ; } ; } ; }
application/json : { articleNumber ?: null | string ; articleSystemId ?: number ; dangerousGoods ?: { dangerousGoodsCoefficient ?: null | number ; emsCode ?: null | string ; unIsMarineHazard ?: boolean ; unLabelNumbers ?: null | string ; unNumber ?: { unClassNumber ?: null | string ; unNumber ?: null | string ; unTunnelCodes ?: null | { unTunnelCode ?: null | string ; } [] ; } ; unPackageType ?: null | string ; unProperShippingNames ?: null | { languageCode ?: null | string ; name ?: null | string ; } [] ; } ; }
Optional article Number ?: null | string
Optional article System Id ?: number
Optional dangerous Goods ?: { dangerousGoodsCoefficient ?: null | number ; emsCode ?: null | string ; unIsMarineHazard ?: boolean ; unLabelNumbers ?: null | string ; unNumber ?: { unClassNumber ?: null | string ; unNumber ?: null | string ; unTunnelCodes ?: null | { unTunnelCode ?: null | string ; } [] ; } ; unPackageType ?: null | string ; unProperShippingNames ?: null | { languageCode ?: null | string ; name ?: null | string ; } [] ; }
Optional dangerous Goods Coefficient ?: null | number
Optional ems Code ?: null | string
Optional un Is Marine Hazard ?: boolean
Optional un Label Numbers ?: null | string
Optional un Number ?: { unClassNumber ?: null | string ; unNumber ?: null | string ; unTunnelCodes ?: null | { unTunnelCode ?: null | string ; } [] ; }
Optional un Class Number ?: null | string
Optional un Number ?: null | string
Optional un Tunnel Codes ?: null | { unTunnelCode ?: null | string ; } []
Optional un Package Type ?: null | string
Optional un Proper Shipping Names ?: null | { languageCode ?: null | string ; name ?: null | string ; } []
put : { parameters : { path : { articleSystemId : number ; } ; } ; requestBody : { content : { application/json : { dangerousGoodsCoefficient ?: null | number ; emsCode ?: null | string ; unIsMarineHazard ?: boolean ; unLabelNumbers ?: null | string ; unNumber : string ; unPackageType ?: null | string ; unProperShippingNames ?: null | { languageCode ?: null | string ; name ?: null | string ; } [] ; } ; } ; } ; responses : { 200 : { content : { application/json : { articleSystemId ?: null | number ; message ?: null | string ; } ; } ; } ; } ; }
parameters : { path : { articleSystemId : number ; } ; }
path : { articleSystemId : number ; }
request Body : { content : { application/json : { dangerousGoodsCoefficient ?: null | number ; emsCode ?: null | string ; unIsMarineHazard ?: boolean ; unLabelNumbers ?: null | string ; unNumber : string ; unPackageType ?: null | string ; unProperShippingNames ?: null | { languageCode ?: null | string ; name ?: null | string ; } [] ; } ; } ; }
content : { application/json : { dangerousGoodsCoefficient ?: null | number ; emsCode ?: null | string ; unIsMarineHazard ?: boolean ; unLabelNumbers ?: null | string ; unNumber : string ; unPackageType ?: null | string ; unProperShippingNames ?: null | { languageCode ?: null | string ; name ?: null | string ; } [] ; } ; }
application/json : { dangerousGoodsCoefficient ?: null | number ; emsCode ?: null | string ; unIsMarineHazard ?: boolean ; unLabelNumbers ?: null | string ; unNumber : string ; unPackageType ?: null | string ; unProperShippingNames ?: null | { languageCode ?: null | string ; name ?: null | string ; } [] ; }
Optional dangerous Goods Coefficient ?: null | number
Optional ems Code ?: null | string
Optional un Is Marine Hazard ?: boolean
Optional un Label Numbers ?: null | string
un Number : string
Optional un Package Type ?: null | string
Optional un Proper Shipping Names ?: null | { languageCode ?: null | string ; name ?: null | string ; } []
responses : { 200 : { content : { application/json : { articleSystemId ?: null | number ; message ?: null | string ; } ; } ; } ; }
200 : { content : { application/json : { articleSystemId ?: null | number ; message ?: null | string ; } ; } ; }
content : { application/json : { articleSystemId ?: null | number ; message ?: null | string ; } ; }
application/json : { articleSystemId ?: null | number ; message ?: null | string ; }
Optional article System Id ?: null | number
Optional message ?: null | string
/api/v1/articles/{article System Id}/files
/api/v1/articles/{article System Id}/files : { get : { parameters : { path : { articleSystemId : number ; } ; } ; responses : { 200 : { content : { application/json : null | { articleSystemId ?: null | number ; fileDataBase64 ?: null | string ; fileId ?: number ; fileName ?: null | string ; mimeType ?: null | string ; orderId ?: null | number ; purchaseOrderId ?: null | number ; } [] ; } ; } ; } ; } ; post : { parameters : { path : { articleSystemId : number ; } ; } ; requestBody : { content : { application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; } ; put : { parameters : { path : { articleSystemId : number ; } ; query : { fileName : null | string ; } ; } ; requestBody : { content : { application/json : { fileDataBase64 : string ; mimeType : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; } ; }
Type declaration
get : { parameters : { path : { articleSystemId : number ; } ; } ; responses : { 200 : { content : { application/json : null | { articleSystemId ?: null | number ; fileDataBase64 ?: null | string ; fileId ?: number ; fileName ?: null | string ; mimeType ?: null | string ; orderId ?: null | number ; purchaseOrderId ?: null | number ; } [] ; } ; } ; } ; }
parameters : { path : { articleSystemId : number ; } ; }
path : { articleSystemId : number ; }
responses : { 200 : { content : { application/json : null | { articleSystemId ?: null | number ; fileDataBase64 ?: null | string ; fileId ?: number ; fileName ?: null | string ; mimeType ?: null | string ; orderId ?: null | number ; purchaseOrderId ?: null | number ; } [] ; } ; } ; }
200 : { content : { application/json : null | { articleSystemId ?: null | number ; fileDataBase64 ?: null | string ; fileId ?: number ; fileName ?: null | string ; mimeType ?: null | string ; orderId ?: null | number ; purchaseOrderId ?: null | number ; } [] ; } ; }
content : { application/json : null | { articleSystemId ?: null | number ; fileDataBase64 ?: null | string ; fileId ?: number ; fileName ?: null | string ; mimeType ?: null | string ; orderId ?: null | number ; purchaseOrderId ?: null | number ; } [] ; }
application/json : null | { articleSystemId ?: null | number ; fileDataBase64 ?: null | string ; fileId ?: number ; fileName ?: null | string ; mimeType ?: null | string ; orderId ?: null | number ; purchaseOrderId ?: null | number ; } []
post : { parameters : { path : { articleSystemId : number ; } ; } ; requestBody : { content : { application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; }
parameters : { path : { articleSystemId : number ; } ; }
path : { articleSystemId : number ; }
request Body : { content : { application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; } ; } ; }
content : { application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; } ; }
application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; }
Optional advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; }
Optional printing Info ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; }
Optional print As User ?: { userId ?: null | number ; }
Optional user Id ?: null | number
Optional print As Workstation ?: { workstationId ?: null | number ; }
Optional workstation Id ?: null | number
Optional report Id ?: null | number
file Data Base64 : string
file Name : string
mime Type : string
responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; }
200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; }
content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; }
application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; }
Optional file Id ?: null | number
Optional message ?: null | string
Optional success ?: boolean
put : { parameters : { path : { articleSystemId : number ; } ; query : { fileName : null | string ; } ; } ; requestBody : { content : { application/json : { fileDataBase64 : string ; mimeType : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; }
parameters : { path : { articleSystemId : number ; } ; query : { fileName : null | string ; } ; }
path : { articleSystemId : number ; }
query : { fileName : null | string ; }
request Body : { content : { application/json : { fileDataBase64 : string ; mimeType : string ; } ; } ; }
content : { application/json : { fileDataBase64 : string ; mimeType : string ; } ; }
application/json : { fileDataBase64 : string ; mimeType : string ; }
file Data Base64 : string
mime Type : string
responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; }
200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; }
content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; }
application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; }
Optional file Id ?: null | number
Optional message ?: null | string
Optional success ?: boolean
/api/v1/articles/{article System Id}/files/{file Id}
/api/v1/articles/{article System Id}/files/{file Id} : { put : { parameters : { path : { articleSystemId : number ; fileId : number ; } ; } ; requestBody : { content : { application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; } ; }
Type declaration
put : { parameters : { path : { articleSystemId : number ; fileId : number ; } ; } ; requestBody : { content : { application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; }
parameters : { path : { articleSystemId : number ; fileId : number ; } ; }
path : { articleSystemId : number ; fileId : number ; }
article System Id : number
file Id : number
request Body : { content : { application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; } ; } ; }
content : { application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; } ; }
application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; }
Optional advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; }
Optional printing Info ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; }
Optional print As User ?: { userId ?: null | number ; }
Optional user Id ?: null | number
Optional print As Workstation ?: { workstationId ?: null | number ; }
Optional workstation Id ?: null | number
Optional report Id ?: null | number
file Data Base64 : string
file Name : string
mime Type : string
responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; }
200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; }
content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; }
application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; }
Optional file Id ?: null | number
Optional message ?: null | string
Optional success ?: boolean
/api/v1/articles/{article System Id}/structure Definition
/api/v1/articles/{article System Id}/structure Definition : { get : { parameters : { path : { articleSystemId : number ; } ; } ; responses : { 200 : { content : { application/json : { articleKind ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; rows ?: null | { articleNumber ?: null | string ; articleSystemId ?: number ; numberOfItems ?: null | number ; } [] ; } ; } ; } ; } ; } ; }
Type declaration
get : { parameters : { path : { articleSystemId : number ; } ; } ; responses : { 200 : { content : { application/json : { articleKind ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; rows ?: null | { articleNumber ?: null | string ; articleSystemId ?: number ; numberOfItems ?: null | number ; } [] ; } ; } ; } ; } ; }
parameters : { path : { articleSystemId : number ; } ; }
path : { articleSystemId : number ; }
responses : { 200 : { content : { application/json : { articleKind ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; rows ?: null | { articleNumber ?: null | string ; articleSystemId ?: number ; numberOfItems ?: null | number ; } [] ; } ; } ; } ; }
200 : { content : { application/json : { articleKind ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; rows ?: null | { articleNumber ?: null | string ; articleSystemId ?: number ; numberOfItems ?: null | number ; } [] ; } ; } ; }
content : { application/json : { articleKind ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; rows ?: null | { articleNumber ?: null | string ; articleSystemId ?: number ; numberOfItems ?: null | number ; } [] ; } ; }
application/json : { articleKind ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; rows ?: null | { articleNumber ?: null | string ; articleSystemId ?: number ; numberOfItems ?: null | number ; } [] ; }
Optional article Kind ?: null | string
Optional article Number ?: null | string
Optional article System Id ?: number
Optional rows ?: null | { articleNumber ?: null | string ; articleSystemId ?: number ; numberOfItems ?: null | number ; } []
/api/v1/inventory Adjustments
/api/v1/inventory Adjustments : { get : { parameters : { query : { from ?: null | string ; goodsOwnerId : number ; isReported ?: null | boolean ; to ?: null | string ; toTime ?: null | string ; } ; } ; requestBody : { content : { application/json : { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; productCode ?: null | string ; } ; inventoryAdjustments ?: null | { articleItemComment ?: null | string ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batchNumber ?: null | string ; expiryDate ?: null | string ; inventoryAdjustmentCause ?: { code ?: null | string ; name ?: null | string ; } ; inventoryId ?: number ; inventoryItemComment ?: null | string ; inventoryTime ?: string ; location ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } [] ; } ; } ; } ; responses : { 200 : { content : { application/json : null | { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; productCode ?: null | string ; } ; inventoryAdjustments ?: null | { articleItemComment ?: null | string ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batchNumber ?: null | string ; expiryDate ?: null | string ; inventoryAdjustmentCause ?: { code ?: null | string ; name ?: null | string ; } ; inventoryId ?: number ; inventoryItemComment ?: null | string ; inventoryTime ?: string ; location ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } [] ; } [] ; } ; } ; } ; } ; }
Type declaration
get : { parameters : { query : { from ?: null | string ; goodsOwnerId : number ; isReported ?: null | boolean ; to ?: null | string ; toTime ?: null | string ; } ; } ; requestBody : { content : { application/json : { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; productCode ?: null | string ; } ; inventoryAdjustments ?: null | { articleItemComment ?: null | string ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batchNumber ?: null | string ; expiryDate ?: null | string ; inventoryAdjustmentCause ?: { code ?: null | string ; name ?: null | string ; } ; inventoryId ?: number ; inventoryItemComment ?: null | string ; inventoryTime ?: string ; location ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } [] ; } ; } ; } ; responses : { 200 : { content : { application/json : null | { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; productCode ?: null | string ; } ; inventoryAdjustments ?: null | { articleItemComment ?: null | string ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batchNumber ?: null | string ; expiryDate ?: null | string ; inventoryAdjustmentCause ?: { code ?: null | string ; name ?: null | string ; } ; inventoryId ?: number ; inventoryItemComment ?: null | string ; inventoryTime ?: string ; location ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } [] ; } [] ; } ; } ; } ; }
parameters : { query : { from ?: null | string ; goodsOwnerId : number ; isReported ?: null | boolean ; to ?: null | string ; toTime ?: null | string ; } ; }
query : { from ?: null | string ; goodsOwnerId : number ; isReported ?: null | boolean ; to ?: null | string ; toTime ?: null | string ; }
Optional from ?: null | string
goods Owner Id : number
Optional is Reported ?: null | boolean
Optional to ?: null | string
Optional to Time ?: null | string
request Body : { content : { application/json : { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; productCode ?: null | string ; } ; inventoryAdjustments ?: null | { articleItemComment ?: null | string ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batchNumber ?: null | string ; expiryDate ?: null | string ; inventoryAdjustmentCause ?: { code ?: null | string ; name ?: null | string ; } ; inventoryId ?: number ; inventoryItemComment ?: null | string ; inventoryTime ?: string ; location ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } [] ; } ; } ; }
content : { application/json : { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; productCode ?: null | string ; } ; inventoryAdjustments ?: null | { articleItemComment ?: null | string ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batchNumber ?: null | string ; expiryDate ?: null | string ; inventoryAdjustmentCause ?: { code ?: null | string ; name ?: null | string ; } ; inventoryId ?: number ; inventoryItemComment ?: null | string ; inventoryTime ?: string ; location ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } [] ; } ; }
application/json : { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; productCode ?: null | string ; } ; inventoryAdjustments ?: null | { articleItemComment ?: null | string ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batchNumber ?: null | string ; expiryDate ?: null | string ; inventoryAdjustmentCause ?: { code ?: null | string ; name ?: null | string ; } ; inventoryId ?: number ; inventoryItemComment ?: null | string ; inventoryTime ?: string ; location ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } [] ; }
Optional article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; productCode ?: null | string ; }
Optional article Name ?: null | string
Optional article Number ?: null | string
Optional article System Id ?: number
Optional product Code ?: null | string
Optional inventory Adjustments ?: null | { articleItemComment ?: null | string ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batchNumber ?: null | string ; expiryDate ?: null | string ; inventoryAdjustmentCause ?: { code ?: null | string ; name ?: null | string ; } ; inventoryId ?: number ; inventoryItemComment ?: null | string ; inventoryTime ?: string ; location ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } []
responses : { 200 : { content : { application/json : null | { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; productCode ?: null | string ; } ; inventoryAdjustments ?: null | { articleItemComment ?: null | string ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batchNumber ?: null | string ; expiryDate ?: null | string ; inventoryAdjustmentCause ?: { code ?: null | string ; name ?: null | string ; } ; inventoryId ?: number ; inventoryItemComment ?: null | string ; inventoryTime ?: string ; location ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } [] ; } [] ; } ; } ; }
200 : { content : { application/json : null | { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; productCode ?: null | string ; } ; inventoryAdjustments ?: null | { articleItemComment ?: null | string ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batchNumber ?: null | string ; expiryDate ?: null | string ; inventoryAdjustmentCause ?: { code ?: null | string ; name ?: null | string ; } ; inventoryId ?: number ; inventoryItemComment ?: null | string ; inventoryTime ?: string ; location ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } [] ; } [] ; } ; }
content : { application/json : null | { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; productCode ?: null | string ; } ; inventoryAdjustments ?: null | { articleItemComment ?: null | string ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batchNumber ?: null | string ; expiryDate ?: null | string ; inventoryAdjustmentCause ?: { code ?: null | string ; name ?: null | string ; } ; inventoryId ?: number ; inventoryItemComment ?: null | string ; inventoryTime ?: string ; location ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } [] ; } [] ; }
application/json : null | { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; productCode ?: null | string ; } ; inventoryAdjustments ?: null | { articleItemComment ?: null | string ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batchNumber ?: null | string ; expiryDate ?: null | string ; inventoryAdjustmentCause ?: { code ?: null | string ; name ?: null | string ; } ; inventoryId ?: number ; inventoryItemComment ?: null | string ; inventoryTime ?: string ; location ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } [] ; } []
/api/v1/inventory Adjustments/{inventory Id}
/api/v1/inventory Adjustments/{inventory Id} : { get : { parameters : { path : { inventoryId : number ; } ; } ; responses : { 200 : { content : { application/json : { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; productCode ?: null | string ; } ; inventoryAdjustments ?: null | { articleItemComment ?: null | string ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batchNumber ?: null | string ; expiryDate ?: null | string ; inventoryAdjustmentCause ?: { code ?: null | string ; name ?: null | string ; } ; inventoryId ?: number ; inventoryItemComment ?: null | string ; inventoryTime ?: string ; location ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } [] ; } ; } ; } ; } ; } ; }
Type declaration
get : { parameters : { path : { inventoryId : number ; } ; } ; responses : { 200 : { content : { application/json : { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; productCode ?: null | string ; } ; inventoryAdjustments ?: null | { articleItemComment ?: null | string ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batchNumber ?: null | string ; expiryDate ?: null | string ; inventoryAdjustmentCause ?: { code ?: null | string ; name ?: null | string ; } ; inventoryId ?: number ; inventoryItemComment ?: null | string ; inventoryTime ?: string ; location ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } [] ; } ; } ; } ; } ; }
parameters : { path : { inventoryId : number ; } ; }
path : { inventoryId : number ; }
responses : { 200 : { content : { application/json : { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; productCode ?: null | string ; } ; inventoryAdjustments ?: null | { articleItemComment ?: null | string ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batchNumber ?: null | string ; expiryDate ?: null | string ; inventoryAdjustmentCause ?: { code ?: null | string ; name ?: null | string ; } ; inventoryId ?: number ; inventoryItemComment ?: null | string ; inventoryTime ?: string ; location ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } [] ; } ; } ; } ; }
200 : { content : { application/json : { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; productCode ?: null | string ; } ; inventoryAdjustments ?: null | { articleItemComment ?: null | string ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batchNumber ?: null | string ; expiryDate ?: null | string ; inventoryAdjustmentCause ?: { code ?: null | string ; name ?: null | string ; } ; inventoryId ?: number ; inventoryItemComment ?: null | string ; inventoryTime ?: string ; location ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } [] ; } ; } ; }
content : { application/json : { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; productCode ?: null | string ; } ; inventoryAdjustments ?: null | { articleItemComment ?: null | string ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batchNumber ?: null | string ; expiryDate ?: null | string ; inventoryAdjustmentCause ?: { code ?: null | string ; name ?: null | string ; } ; inventoryId ?: number ; inventoryItemComment ?: null | string ; inventoryTime ?: string ; location ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } [] ; } ; }
application/json : { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; productCode ?: null | string ; } ; inventoryAdjustments ?: null | { articleItemComment ?: null | string ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batchNumber ?: null | string ; expiryDate ?: null | string ; inventoryAdjustmentCause ?: { code ?: null | string ; name ?: null | string ; } ; inventoryId ?: number ; inventoryItemComment ?: null | string ; inventoryTime ?: string ; location ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } [] ; }
Optional article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; productCode ?: null | string ; }
Optional article Name ?: null | string
Optional article Number ?: null | string
Optional article System Id ?: number
Optional product Code ?: null | string
Optional inventory Adjustments ?: null | { articleItemComment ?: null | string ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batchNumber ?: null | string ; expiryDate ?: null | string ; inventoryAdjustmentCause ?: { code ?: null | string ; name ?: null | string ; } ; inventoryId ?: number ; inventoryItemComment ?: null | string ; inventoryTime ?: string ; location ?: null | string ; numberOfItems ?: number ; serial ?: null | string ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } []
/api/v1/inventory Adjustments/{inventory Id}/articles/{article System Id}/set Reported
/api/v1/inventory Adjustments/{inventory Id}/articles/{article System Id}/set Reported : { patch : { parameters : { path : { articleSystemId : number ; inventoryId : number ; } ; } ; responses : { 200 : { content : { application/json : { items ?: null | { articleItemId ?: number ; inventoryArticleItemId ?: number ; } [] ; message ?: null | string ; } ; } ; } ; } ; } ; }
Type declaration
patch : { parameters : { path : { articleSystemId : number ; inventoryId : number ; } ; } ; responses : { 200 : { content : { application/json : { items ?: null | { articleItemId ?: number ; inventoryArticleItemId ?: number ; } [] ; message ?: null | string ; } ; } ; } ; } ; }
parameters : { path : { articleSystemId : number ; inventoryId : number ; } ; }
path : { articleSystemId : number ; inventoryId : number ; }
article System Id : number
inventory Id : number
responses : { 200 : { content : { application/json : { items ?: null | { articleItemId ?: number ; inventoryArticleItemId ?: number ; } [] ; message ?: null | string ; } ; } ; } ; }
200 : { content : { application/json : { items ?: null | { articleItemId ?: number ; inventoryArticleItemId ?: number ; } [] ; message ?: null | string ; } ; } ; }
content : { application/json : { items ?: null | { articleItemId ?: number ; inventoryArticleItemId ?: number ; } [] ; message ?: null | string ; } ; }
application/json : { items ?: null | { articleItemId ?: number ; inventoryArticleItemId ?: number ; } [] ; message ?: null | string ; }
Optional items ?: null | { articleItemId ?: number ; inventoryArticleItemId ?: number ; } []
Optional message ?: null | string
/api/v1/orders
/api/v1/orders : { delete : { parameters : { query : { goodsOwnerId : number ; orderNumber : null | string ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: null | number ; } ; } ; } ; } ; } ; get : { parameters : { query : { articleNumbers ?: null | string [] ; backOrderForOrderId ?: null | number ; goodsOwnerId : number ; lastReturnedFrom ?: null | string ; marketPlace ?: null | string ; maxOrdersToGet ?: null | number ; onlyIfTransportPrinted ?: null | boolean ; onlyOrdersWithOrderLinesToReport ?: null | boolean ; onlyOrdersWithOrderLinesToReportReturned ?: null | boolean ; orderCreatedTimeFrom ?: null | string ; orderCreatedTimeTo ?: null | string ; orderIdFrom ?: null | number ; orderNumber ?: null | string ; orderNumbers ?: null | string [] ; orderStatusChangedTimeFrom ?: null | string ; orderStatusFrom ?: null | number ; orderStatusTo ?: null | number ; orderUpdatedTimeFrom ?: null | string ; parcelNumber ?: null | string ; pickable ?: null | string ; serial ?: null | string ; shipmentId ?: null | number ; shippedTimeFrom ?: null | string ; shippedTimeTo ?: null | string ; } ; } ; responses : { 200 : { content : { application/json : { classes ?: null | ( { code ?: null | string ; name ?: null | string ; } & Record < string , never > ) [] ; consignee ?: { address1 ?: null | string ; address2 ?: null | string ; address3 ?: null | string ; advanced ?: { emailNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; smsNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; telephoneNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; } ; city ?: null | string ; countryCode ?: null | string ; countryStateCode ?: null | string ; customerNumber ?: null | string ; doorCode ?: null | string ; id ?: number ; invoiceAddress ?: { address1 ?: null | string ; address2 ?: null | string ; address3 ?: null | string ; advanced ?: { emailNotification ?: { value ?: null | string ; } ; smsNotification ?: { value ?: null | string ; } ; telephoneNotification ?: { value ?: null | string ; } ; } ; city ?: null | string ; countryCode ?: null | string ; countryStateCode ?: null | string ; name ?: null | string ; postCode ?: null | string ; } ; name ?: null | string ; postCode ?: null | string ; remark ?: null | string ; } ; goodsOwner ?: { id ?: number ; name ?: null | string ; } ; orderInfo ?: { advanced ?: { arrivalDate ?: null | string ; backOrderInfo ?: { backOrderForOrderId ?: number ; } ; deliveryDateWithTime ?: string ; invoiceNumber ?: null | string ; } ; allocatedNumberOfItems ?: number ; consigneeOrderNumber ?: null | string ; createdDate ?: string ; customerPrice ?: null | number ; customsInfo ?: { customsValueCurrencyCode ?: null | string ; } ; deliveryDate ?: string ; deliveryInstruction ?: null | string ; emailNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; freeText1 ?: null | string ; freeText2 ?: null | string ; freeText3 ?: null | string ; goodsOwnerOrderId ?: null | string ; marketPlace ?: { marketPlace ?: null | string ; marketPlaceOrderNumber ?: null | string ; } ; orderId ?: number ; orderNumber ?: null | string ; orderRemark ?: null | string ; orderStatus ?: { number ?: number ; text ?: null | string ; } ; orderType ?: { code ?: null | string ; name ?: null | string ; } ; orderedNumberOfItems ?: number ; pickedNumberOfItems ?: number ; pickingPriority ?: null | number ; preparedTransportDocumentId ?: null | string ; productionCode ?: null | string ; referenceNumber ?: null | string ; returnWayBill ?: null | string ; salesCode ?: null | string ; servicePointCode ?: null | string ; shippedTime ?: null | string ; smsNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; telephoneNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; termsOfDeliveryType ?: { code ?: null | string ; name ?: null | string ; } ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; warehouseInstruction ?: null | string ; wayBill ?: null | string ; wayOfDelivery ?: { code ?: null | string ; name ?: null | string ; } ; } ; orderLines ?: null | { allocatedNumberOfItems ?: number ; article ?: { articleKind ?: null | string ; articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; productCode ?: null | string ; } ; batchNumber ?: null | string ; comment ?: null | string ; customerArticleNumber ?: null | string ; externalId ?: null | string ; freeValues ?: { freeText1 ?: null | string ; } ; id ?: number ; lineTotalCustomsValue ?: null | number ; lineType ?: { code ?: null | string ; name ?: null | string ; } ; orderedNumberOfItems ?: number ; packedNumberOfItems ?: number ; pickedArticleItems ?: null | { articleItemId ?: number ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batchNumber ?: null | string ; caseNumber ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; freeText1 ?: null | string ; handling ?: { packedByUserId ?: null | number ; pickedByUserId ?: null | number ; } ; inDate ?: string ; isPicked ?: boolean ; isReturned ?: boolean ; location ?: null | string ; locationTypeCode ?: null | string ; numberOfItems ?: number ; packedTime ?: null | string ; parcel ?: { advanced ?: { parcelSerialNumber ?: null | string ; } ; id ?: number ; parcelNumber ?: null | string ; parcelType ?: { code ?: null | string ; } ; parentParcel ?: { advanced ?: { parcelSerialNumber ?: null | string ; } ; id ?: number ; parcelNumber ?: null | string ; parcelType ?: { code ?: null | string ; } ; } ; } ; pickedTime ?: null | string ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnDate ?: null | string ; serial ?: null | string ; volume ?: null | number ; weight ?: null | number ; zoneName ?: null | string ; } [] ; pickedNumberOfItems ?: number ; prices ?: { currencyCode ?: null | string ; customerLinePrice ?: null | number ; discountPercentage ?: null | number ; linePrice ?: null | number ; } ; reportedNumberOfItems ?: null | number ; reportedReturnedNumberOfItems ?: null | number ; returnedNumberOfItems ?: number ; rowNumber ?: null | string ; serialNumber ?: null | string ; shouldBePicked ?: boolean ; subOrderLines ?: null | ( { id?: number | undefined; rowNumber?: string | null | undefined; article?: { articleSystemId?: number | undefined; articleNumber?: string | null | undefined; articleName?: string | null | undefined; productCode?: string | ... 1 more ... | undefined; articleKind?: string | ... 1 more ... | undefined; } | undefined; ...) [] ; } [] ; parcels ?: null | { advanced ?: { parcelSerialNumber ?: null | string ; } ; id ?: number ; isReturnParcel ?: boolean ; parcelNumber ?: null | string ; tracking ?: { trackingUrl ?: null | string ; } ; } [] ; returnTransporter ?: { code ?: null | string ; name ?: null | string ; serviceCode ?: null | string ; serviceComment ?: null | string ; transporterContract ?: { comment ?: null | string ; } ; transporterName ?: null | string ; } ; shipmentInfo ?: { shipmentId ?: number ; } ; tracking ?: null | { created ?: string ; trackingUrl ?: null | string ; waybill ?: null | string ; } [] ; transporter ?: { code ?: null | string ; name ?: null | string ; serviceCode ?: null | string ; serviceComment ?: null | string ; transporterContract ?: { comment ?: null | string ; } ; transporterName ?: null | string ; } ; } [] ; } ; } ; } ; } ; put : { requestBody : { content : { application/json : { advanced ?: { arrivalDate ?: null | string ; arrivalDateFrom ?: null | string ; communication ?: null | string ; invoiceNumber ?: null | string ; orderTextLines ?: null | { comment ?: null | string ; numberOfItems ?: number ; rowNumber : string ; } [] ; termsOfDeliveryString ?: null | string ; termsOfPaymentString ?: null | string ; transporterOrderNumber ?: null | string ; wayOfDeliveryString ?: null | string ; } ; classes ?: null | { code ?: null | string ; comment ?: null | string ; name ?: null | string ; } [] ; consignee : { address1 ?: null | string ; address2 ?: null | string ; address3 ?: null | string ; advanced ?: { emailNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; externalCustomerCode ?: null | string ; smsNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; telephoneNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; } ; city ?: null | string ; countryCode ?: null | string ; countryStateCode ?: null | string ; customerNumber ?: null | string ; doorCode ?: null | string ; invoiceAddress ?: { address1 ?: null | string ; address2 ?: null | string ; address3 ?: null | string ; advanced ?: { emailNotification ?: { value ?: null | string ; } ; smsNotification ?: { value ?: null | string ; } ; telephoneNotification ?: { value ?: null | string ; } ; } ; city ?: null | string ; countryCode ?: null | string ; countryStateCode ?: null | string ; name ?: null | string ; postCode ?: null | string ; } ; name ?: null | string ; organisationNumber ?: null | string ; postCode ?: null | string ; remark ?: null | string ; vatNumber ?: null | string ; } ; consigneeOrderNumber ?: null | string ; customerPrice ?: null | number ; customsInfo ?: { customsValueCurrencyCode ?: null | string ; } ; deliveryDate : string ; deliveryInstruction ?: null | string ; emailNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; freeText1 ?: null | string ; freeText2 ?: null | string ; freeText3 ?: null | string ; freightPrice ?: null | number ; goodsOwnerId : number ; goodsOwnerOrderId ?: null | string ; marketPlace ?: { marketPlace ?: null | string ; marketPlaceOrderNumber ?: null | string ; } ; orderFreeDateTime1 ?: null | string ; orderLines ?: null | { articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; articleNumber : string ; batchNumber ?: null | string ; comment ?: null | string ; customerArticleNumber ?: null | string ; externalId ?: null | string ; lineFreeValues ?: { freeText1 ?: null | string ; } ; lineTotalCustomsValue ?: null | number ; lineType ?: { code ?: null | string ; name ?: null | string ; } ; numberOfItems ?: number ; prices ?: { currencyCode ?: null | string ; customerLinePrice ?: null | number ; discountPercentage ?: null | number ; linePrice ?: null | number ; } ; rowNumber : string ; serialNumber ?: null | string ; shouldBePicked ?: null | boolean ; warehouseInstruction ?: null | string ; } [] ; orderNumber : string ; orderRemark ?: null | string ; orderType ?: { code ?: null | string ; name ?: null | string ; } ; pickingPriority ?: null | number ; preparedTransportDocumentId ?: null | string ; productionCode ?: null | string ; referenceNumber ?: null | string ; returnTransporter ?: { transporterCode ?: null | string ; transporterServiceCode ?: null | string ; } ; salesCode ?: null | string ; servicePointCode ?: null | string ; smsNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; telephoneNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; termsOfDeliveryType ?: { code ?: null | string ; name ?: null | string ; } ; transporter ?: { paymentAdvanced ?: { consigneeCollects ?: null | boolean ; consigneePays ?: { customerNumber : string ; } ; senderPays ?: { ediCode : string ; } ; thirdPartyPays ?: { customerNumber : string ; } ; } ; transporterCode ?: null | string ; transporterServiceCode ?: null | string ; } ; transporterBulkId ?: null | string ; warehouseId ?: null | number ; warehouseInstruction ?: null | string ; wayOfDelivery ?: { code ?: null | string ; name ?: null | string ; } ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: null | number ; } ; } ; } ; 201 : { content : { application/json : { message ?: null | string ; orderId ?: null | number ; } ; } ; } ; } ; } ; }
/api/v1/orders/classes
/api/v1/orders/classes : { get : { parameters : { query : { goodsOwnerId : number ; } ; } ; responses : { 200 : { content : { application/json : { orderClasses ?: null | { code ?: null | string ; comment ?: null | string ; name ?: null | string ; } [] ; } ; } ; } ; } ; } ; }
Type declaration
get : { parameters : { query : { goodsOwnerId : number ; } ; } ; responses : { 200 : { content : { application/json : { orderClasses ?: null | { code ?: null | string ; comment ?: null | string ; name ?: null | string ; } [] ; } ; } ; } ; } ; }
parameters : { query : { goodsOwnerId : number ; } ; }
query : { goodsOwnerId : number ; }
responses : { 200 : { content : { application/json : { orderClasses ?: null | { code ?: null | string ; comment ?: null | string ; name ?: null | string ; } [] ; } ; } ; } ; }
200 : { content : { application/json : { orderClasses ?: null | { code ?: null | string ; comment ?: null | string ; name ?: null | string ; } [] ; } ; } ; }
content : { application/json : { orderClasses ?: null | { code ?: null | string ; comment ?: null | string ; name ?: null | string ; } [] ; } ; }
application/json : { orderClasses ?: null | { code ?: null | string ; comment ?: null | string ; name ?: null | string ; } [] ; }
Optional order Classes ?: null | { code ?: null | string ; comment ?: null | string ; name ?: null | string ; } []
/api/v1/orders/statuses
/api/v1/orders/statuses : { get : { responses : { 200 : { content : { application/json : { orderStatuses ?: null | { number ?: number ; text ?: null | string ; } [] ; } ; } ; } ; } ; } ; }
Type declaration
get : { responses : { 200 : { content : { application/json : { orderStatuses ?: null | { number ?: number ; text ?: null | string ; } [] ; } ; } ; } ; } ; }
responses : { 200 : { content : { application/json : { orderStatuses ?: null | { number ?: number ; text ?: null | string ; } [] ; } ; } ; } ; }
200 : { content : { application/json : { orderStatuses ?: null | { number ?: number ; text ?: null | string ; } [] ; } ; } ; }
content : { application/json : { orderStatuses ?: null | { number ?: number ; text ?: null | string ; } [] ; } ; }
application/json : { orderStatuses ?: null | { number ?: number ; text ?: null | string ; } [] ; }
Optional order Statuses ?: null | { number ?: number ; text ?: null | string ; } []
/api/v1/orders/types
/api/v1/orders/types : { get : { parameters : { query : { goodsOwnerId : number ; } ; } ; responses : { 200 : { content : { application/json : { orderTypes ?: null | ( { code ?: null | string ; name ?: null | string ; } & Record < string , never > ) [] ; } ; } ; } ; } ; } ; }
Type declaration
get : { parameters : { query : { goodsOwnerId : number ; } ; } ; responses : { 200 : { content : { application/json : { orderTypes ?: null | ( { code ?: null | string ; name ?: null | string ; } & Record < string , never > ) [] ; } ; } ; } ; } ; }
parameters : { query : { goodsOwnerId : number ; } ; }
query : { goodsOwnerId : number ; }
responses : { 200 : { content : { application/json : { orderTypes ?: null | ( { code ?: null | string ; name ?: null | string ; } & Record < string , never > ) [] ; } ; } ; } ; }
200 : { content : { application/json : { orderTypes ?: null | ( { code ?: null | string ; name ?: null | string ; } & Record < string , never > ) [] ; } ; } ; }
content : { application/json : { orderTypes ?: null | ( { code ?: null | string ; name ?: null | string ; } & Record < string , never > ) [] ; } ; }
application/json : { orderTypes ?: null | ( { code ?: null | string ; name ?: null | string ; } & Record < string , never > ) [] ; }
Optional order Types ?: null | ( { code ?: null | string ; name ?: null | string ; } & Record < string , never > ) []
/api/v1/orders/way Of Delivery Types
/api/v1/orders/way Of Delivery Types : { get : { parameters : { query : { goodsOwnerId : number ; } ; } ; responses : { 200 : { content : { application/json : { wayOfDeliveryTypes ?: null | { code ?: null | string ; id ?: number ; name ?: null | string ; } [] ; } ; } ; } ; } ; } ; put : { requestBody : { content : { application/json : { code : string ; goodsOwnerId : number ; name : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; success ?: boolean ; wayOfDeliveryTypeId ?: null | number ; } ; } ; } ; } ; } ; }
Type declaration
get : { parameters : { query : { goodsOwnerId : number ; } ; } ; responses : { 200 : { content : { application/json : { wayOfDeliveryTypes ?: null | { code ?: null | string ; id ?: number ; name ?: null | string ; } [] ; } ; } ; } ; } ; }
parameters : { query : { goodsOwnerId : number ; } ; }
query : { goodsOwnerId : number ; }
responses : { 200 : { content : { application/json : { wayOfDeliveryTypes ?: null | { code ?: null | string ; id ?: number ; name ?: null | string ; } [] ; } ; } ; } ; }
200 : { content : { application/json : { wayOfDeliveryTypes ?: null | { code ?: null | string ; id ?: number ; name ?: null | string ; } [] ; } ; } ; }
content : { application/json : { wayOfDeliveryTypes ?: null | { code ?: null | string ; id ?: number ; name ?: null | string ; } [] ; } ; }
application/json : { wayOfDeliveryTypes ?: null | { code ?: null | string ; id ?: number ; name ?: null | string ; } [] ; }
Optional way Of Delivery Types ?: null | { code ?: null | string ; id ?: number ; name ?: null | string ; } []
put : { requestBody : { content : { application/json : { code : string ; goodsOwnerId : number ; name : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; success ?: boolean ; wayOfDeliveryTypeId ?: null | number ; } ; } ; } ; } ; }
request Body : { content : { application/json : { code : string ; goodsOwnerId : number ; name : string ; } ; } ; }
content : { application/json : { code : string ; goodsOwnerId : number ; name : string ; } ; }
application/json : { code : string ; goodsOwnerId : number ; name : string ; }
code : string
goods Owner Id : number
name : string
responses : { 200 : { content : { application/json : { message ?: null | string ; success ?: boolean ; wayOfDeliveryTypeId ?: null | number ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; success ?: boolean ; wayOfDeliveryTypeId ?: null | number ; } ; } ; }
content : { application/json : { message ?: null | string ; success ?: boolean ; wayOfDeliveryTypeId ?: null | number ; } ; }
application/json : { message ?: null | string ; success ?: boolean ; wayOfDeliveryTypeId ?: null | number ; }
Optional message ?: null | string
Optional success ?: boolean
Optional way Of Delivery Type Id ?: null | number
/api/v1/orders/way Of Delivery Types/{way Of Delivery Type Id}
/api/v1/orders/way Of Delivery Types/{way Of Delivery Type Id} : { delete : { parameters : { path : { wayOfDeliveryTypeId : number ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; success ?: boolean ; wayOfDeliveryTypeId ?: null | number ; } ; } ; } ; } ; } ; put : { parameters : { path : { wayOfDeliveryTypeId : number ; } ; } ; requestBody : { content : { application/json : { code : string ; goodsOwnerId : number ; name : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; success ?: boolean ; wayOfDeliveryTypeId ?: null | number ; } ; } ; } ; } ; } ; }
Type declaration
delete : { parameters : { path : { wayOfDeliveryTypeId : number ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; success ?: boolean ; wayOfDeliveryTypeId ?: null | number ; } ; } ; } ; } ; }
parameters : { path : { wayOfDeliveryTypeId : number ; } ; }
path : { wayOfDeliveryTypeId : number ; }
way Of Delivery Type Id : number
responses : { 200 : { content : { application/json : { message ?: null | string ; success ?: boolean ; wayOfDeliveryTypeId ?: null | number ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; success ?: boolean ; wayOfDeliveryTypeId ?: null | number ; } ; } ; }
content : { application/json : { message ?: null | string ; success ?: boolean ; wayOfDeliveryTypeId ?: null | number ; } ; }
application/json : { message ?: null | string ; success ?: boolean ; wayOfDeliveryTypeId ?: null | number ; }
Optional message ?: null | string
Optional success ?: boolean
Optional way Of Delivery Type Id ?: null | number
put : { parameters : { path : { wayOfDeliveryTypeId : number ; } ; } ; requestBody : { content : { application/json : { code : string ; goodsOwnerId : number ; name : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; success ?: boolean ; wayOfDeliveryTypeId ?: null | number ; } ; } ; } ; } ; }
parameters : { path : { wayOfDeliveryTypeId : number ; } ; }
path : { wayOfDeliveryTypeId : number ; }
way Of Delivery Type Id : number
request Body : { content : { application/json : { code : string ; goodsOwnerId : number ; name : string ; } ; } ; }
content : { application/json : { code : string ; goodsOwnerId : number ; name : string ; } ; }
application/json : { code : string ; goodsOwnerId : number ; name : string ; }
code : string
goods Owner Id : number
name : string
responses : { 200 : { content : { application/json : { message ?: null | string ; success ?: boolean ; wayOfDeliveryTypeId ?: null | number ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; success ?: boolean ; wayOfDeliveryTypeId ?: null | number ; } ; } ; }
content : { application/json : { message ?: null | string ; success ?: boolean ; wayOfDeliveryTypeId ?: null | number ; } ; }
application/json : { message ?: null | string ; success ?: boolean ; wayOfDeliveryTypeId ?: null | number ; }
Optional message ?: null | string
Optional success ?: boolean
Optional way Of Delivery Type Id ?: null | number
/api/v1/orders/{order Id}
/api/v1/orders/{order Id} : { delete : { parameters : { path : { orderId : number ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: null | number ; } ; } ; } ; } ; } ; get : { parameters : { path : { orderId : number ; } ; } ; responses : { 200 : { content : { application/json : { classes ?: null | ( { code ?: null | string ; name ?: null | string ; } & Record < string , never > ) [] ; consignee ?: { address1 ?: null | string ; address2 ?: null | string ; address3 ?: null | string ; advanced ?: { emailNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; smsNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; telephoneNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; } ; city ?: null | string ; countryCode ?: null | string ; countryStateCode ?: null | string ; customerNumber ?: null | string ; doorCode ?: null | string ; id ?: number ; invoiceAddress ?: { address1 ?: null | string ; address2 ?: null | string ; address3 ?: null | string ; advanced ?: { emailNotification ?: { value ?: null | string ; } ; smsNotification ?: { value ?: null | string ; } ; telephoneNotification ?: { value ?: null | string ; } ; } ; city ?: null | string ; countryCode ?: null | string ; countryStateCode ?: null | string ; name ?: null | string ; postCode ?: null | string ; } ; name ?: null | string ; postCode ?: null | string ; remark ?: null | string ; } ; goodsOwner ?: { id ?: number ; name ?: null | string ; } ; orderInfo ?: { advanced ?: { arrivalDate ?: null | string ; backOrderInfo ?: { backOrderForOrderId ?: number ; } ; deliveryDateWithTime ?: string ; invoiceNumber ?: null | string ; } ; allocatedNumberOfItems ?: number ; consigneeOrderNumber ?: null | string ; createdDate ?: string ; customerPrice ?: null | number ; customsInfo ?: { customsValueCurrencyCode ?: null | string ; } ; deliveryDate ?: string ; deliveryInstruction ?: null | string ; emailNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; freeText1 ?: null | string ; freeText2 ?: null | string ; freeText3 ?: null | string ; goodsOwnerOrderId ?: null | string ; marketPlace ?: { marketPlace ?: null | string ; marketPlaceOrderNumber ?: null | string ; } ; orderId ?: number ; orderNumber ?: null | string ; orderRemark ?: null | string ; orderStatus ?: { number ?: number ; text ?: null | string ; } ; orderType ?: { code ?: null | string ; name ?: null | string ; } ; orderedNumberOfItems ?: number ; pickedNumberOfItems ?: number ; pickingPriority ?: null | number ; preparedTransportDocumentId ?: null | string ; productionCode ?: null | string ; referenceNumber ?: null | string ; returnWayBill ?: null | string ; salesCode ?: null | string ; servicePointCode ?: null | string ; shippedTime ?: null | string ; smsNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; telephoneNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; termsOfDeliveryType ?: { code ?: null | string ; name ?: null | string ; } ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; warehouseInstruction ?: null | string ; wayBill ?: null | string ; wayOfDelivery ?: { code ?: null | string ; name ?: null | string ; } ; } ; orderLines ?: null | { allocatedNumberOfItems ?: number ; article ?: { articleKind ?: null | string ; articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; productCode ?: null | string ; } ; batchNumber ?: null | string ; comment ?: null | string ; customerArticleNumber ?: null | string ; externalId ?: null | string ; freeValues ?: { freeText1 ?: null | string ; } ; id ?: number ; lineTotalCustomsValue ?: null | number ; lineType ?: { code ?: null | string ; name ?: null | string ; } ; orderedNumberOfItems ?: number ; packedNumberOfItems ?: number ; pickedArticleItems ?: null | { articleItemId ?: number ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batchNumber ?: null | string ; caseNumber ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; freeText1 ?: null | string ; handling ?: { packedByUserId ?: null | number ; pickedByUserId ?: null | number ; } ; inDate ?: string ; isPicked ?: boolean ; isReturned ?: boolean ; location ?: null | string ; locationTypeCode ?: null | string ; numberOfItems ?: number ; packedTime ?: null | string ; parcel ?: { advanced ?: { parcelSerialNumber ?: null | string ; } ; id ?: number ; parcelNumber ?: null | string ; parcelType ?: { code ?: null | string ; } ; parentParcel ?: { advanced ?: { parcelSerialNumber ?: null | string ; } ; id ?: number ; parcelNumber ?: null | string ; parcelType ?: { code ?: null | string ; } ; } ; } ; pickedTime ?: null | string ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnDate ?: null | string ; serial ?: null | string ; volume ?: null | number ; weight ?: null | number ; zoneName ?: null | string ; } [] ; pickedNumberOfItems ?: number ; prices ?: { currencyCode ?: null | string ; customerLinePrice ?: null | number ; discountPercentage ?: null | number ; linePrice ?: null | number ; } ; reportedNumberOfItems ?: null | number ; reportedReturnedNumberOfItems ?: null | number ; returnedNumberOfItems ?: number ; rowNumber ?: null | string ; serialNumber ?: null | string ; shouldBePicked ?: boolean ; subOrderLines ?: null | ( { id?: number | undefined; rowNumber?: string | null | undefined; article?: { articleSystemId?: number | undefined; articleNumber?: string | null | undefined; articleName?: string | null | undefined; productCode?: string | ... 1 more ... | undefined; articleKind?: string | ... 1 more ... | undefined; } | undefined; ...) [] ; } [] ; parcels ?: null | { advanced ?: { parcelSerialNumber ?: null | string ; } ; id ?: number ; isReturnParcel ?: boolean ; parcelNumber ?: null | string ; tracking ?: { trackingUrl ?: null | string ; } ; } [] ; returnTransporter ?: { code ?: null | string ; name ?: null | string ; serviceCode ?: null | string ; serviceComment ?: null | string ; transporterContract ?: { comment ?: null | string ; } ; transporterName ?: null | string ; } ; shipmentInfo ?: { shipmentId ?: number ; } ; tracking ?: null | { created ?: string ; trackingUrl ?: null | string ; waybill ?: null | string ; } [] ; transporter ?: { code ?: null | string ; name ?: null | string ; serviceCode ?: null | string ; serviceComment ?: null | string ; transporterContract ?: { comment ?: null | string ; } ; transporterName ?: null | string ; } ; } ; } ; } ; } ; } ; put : { parameters : { path : { orderId : number ; } ; } ; requestBody : { content : { application/json : { advanced ?: { arrivalDate ?: null | string ; arrivalDateFrom ?: null | string ; communication ?: null | string ; invoiceNumber ?: null | string ; orderTextLines ?: null | { comment ?: null | string ; numberOfItems ?: number ; rowNumber : string ; } [] ; termsOfDeliveryString ?: null | string ; termsOfPaymentString ?: null | string ; transporterOrderNumber ?: null | string ; wayOfDeliveryString ?: null | string ; } ; classes ?: null | { code ?: null | string ; comment ?: null | string ; name ?: null | string ; } [] ; consignee : { address1 ?: null | string ; address2 ?: null | string ; address3 ?: null | string ; advanced ?: { emailNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; externalCustomerCode ?: null | string ; smsNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; telephoneNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; } ; city ?: null | string ; countryCode ?: null | string ; countryStateCode ?: null | string ; customerNumber ?: null | string ; doorCode ?: null | string ; invoiceAddress ?: { address1 ?: null | string ; address2 ?: null | string ; address3 ?: null | string ; advanced ?: { emailNotification ?: { value ?: null | string ; } ; smsNotification ?: { value ?: null | string ; } ; telephoneNotification ?: { value ?: null | string ; } ; } ; city ?: null | string ; countryCode ?: null | string ; countryStateCode ?: null | string ; name ?: null | string ; postCode ?: null | string ; } ; name ?: null | string ; organisationNumber ?: null | string ; postCode ?: null | string ; remark ?: null | string ; vatNumber ?: null | string ; } ; consigneeOrderNumber ?: null | string ; customerPrice ?: null | number ; customsInfo ?: { customsValueCurrencyCode ?: null | string ; } ; deliveryDate : string ; deliveryInstruction ?: null | string ; emailNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; freeText1 ?: null | string ; freeText2 ?: null | string ; freeText3 ?: null | string ; freightPrice ?: null | number ; goodsOwnerId : number ; goodsOwnerOrderId ?: null | string ; marketPlace ?: { marketPlace ?: null | string ; marketPlaceOrderNumber ?: null | string ; } ; orderFreeDateTime1 ?: null | string ; orderLines ?: null | { articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; articleNumber : string ; batchNumber ?: null | string ; comment ?: null | string ; customerArticleNumber ?: null | string ; externalId ?: null | string ; lineFreeValues ?: { freeText1 ?: null | string ; } ; lineTotalCustomsValue ?: null | number ; lineType ?: { code ?: null | string ; name ?: null | string ; } ; numberOfItems ?: number ; prices ?: { currencyCode ?: null | string ; customerLinePrice ?: null | number ; discountPercentage ?: null | number ; linePrice ?: null | number ; } ; rowNumber : string ; serialNumber ?: null | string ; shouldBePicked ?: null | boolean ; warehouseInstruction ?: null | string ; } [] ; orderNumber : string ; orderRemark ?: null | string ; orderType ?: { code ?: null | string ; name ?: null | string ; } ; pickingPriority ?: null | number ; preparedTransportDocumentId ?: null | string ; productionCode ?: null | string ; referenceNumber ?: null | string ; returnTransporter ?: { transporterCode ?: null | string ; transporterServiceCode ?: null | string ; } ; salesCode ?: null | string ; servicePointCode ?: null | string ; smsNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; telephoneNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; termsOfDeliveryType ?: { code ?: null | string ; name ?: null | string ; } ; transporter ?: { paymentAdvanced ?: { consigneeCollects ?: null | boolean ; consigneePays ?: { customerNumber : string ; } ; senderPays ?: { ediCode : string ; } ; thirdPartyPays ?: { customerNumber : string ; } ; } ; transporterCode ?: null | string ; transporterServiceCode ?: null | string ; } ; transporterBulkId ?: null | string ; warehouseId ?: null | number ; warehouseInstruction ?: null | string ; wayOfDelivery ?: { code ?: null | string ; name ?: null | string ; } ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: null | number ; } ; } ; } ; } ; } ; }
/api/v1/orders/{order Id}/add Order Classes
/api/v1/orders/{order Id}/add Order Classes : { patch : { parameters : { path : { orderId : number ; } ; } ; requestBody : { content : { application/json : { classes ?: null | { code ?: null | string ; comment ?: null | string ; name ?: null | string ; } [] ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; } ; } ; }
Type declaration
patch : { parameters : { path : { orderId : number ; } ; } ; requestBody : { content : { application/json : { classes ?: null | { code ?: null | string ; comment ?: null | string ; name ?: null | string ; } [] ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; } ; }
parameters : { path : { orderId : number ; } ; }
path : { orderId : number ; }
request Body : { content : { application/json : { classes ?: null | { code ?: null | string ; comment ?: null | string ; name ?: null | string ; } [] ; } ; } ; }
content : { application/json : { classes ?: null | { code ?: null | string ; comment ?: null | string ; name ?: null | string ; } [] ; } ; }
application/json : { classes ?: null | { code ?: null | string ; comment ?: null | string ; name ?: null | string ; } [] ; }
Optional classes ?: null | { code ?: null | string ; comment ?: null | string ; name ?: null | string ; } []
responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; }
content : { application/json : { message ?: null | string ; orderId ?: number ; } ; }
application/json : { message ?: null | string ; orderId ?: number ; }
Optional message ?: null | string
Optional order Id ?: number
/api/v1/orders/{order Id}/delivery Date
/api/v1/orders/{order Id}/delivery Date : { patch : { parameters : { path : { orderId : number ; } ; } ; requestBody ?: { content : { application/json : { deliveryDate : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; } ; } ; }
Type declaration
patch : { parameters : { path : { orderId : number ; } ; } ; requestBody ?: { content : { application/json : { deliveryDate : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; } ; }
parameters : { path : { orderId : number ; } ; }
path : { orderId : number ; }
Optional request Body ?: { content : { application/json : { deliveryDate : string ; } ; } ; }
content : { application/json : { deliveryDate : string ; } ; }
application/json : { deliveryDate : string ; }
responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; }
content : { application/json : { message ?: null | string ; orderId ?: number ; } ; }
application/json : { message ?: null | string ; orderId ?: number ; }
Optional message ?: null | string
Optional order Id ?: number
/api/v1/orders/{order Id}/files
/api/v1/orders/{order Id}/files : { get : { parameters : { path : { orderId : number ; } ; } ; responses : { 200 : { content : { application/json : null | { articleSystemId ?: null | number ; fileDataBase64 ?: null | string ; fileId ?: number ; fileName ?: null | string ; mimeType ?: null | string ; orderId ?: null | number ; purchaseOrderId ?: null | number ; } [] ; } ; } ; } ; } ; post : { parameters : { path : { orderId : number ; } ; } ; requestBody : { content : { application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; } ; put : { parameters : { path : { orderId : number ; } ; query : { fileName : null | string ; } ; } ; requestBody : { content : { application/json : { fileDataBase64 : string ; mimeType : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; } ; }
Type declaration
get : { parameters : { path : { orderId : number ; } ; } ; responses : { 200 : { content : { application/json : null | { articleSystemId ?: null | number ; fileDataBase64 ?: null | string ; fileId ?: number ; fileName ?: null | string ; mimeType ?: null | string ; orderId ?: null | number ; purchaseOrderId ?: null | number ; } [] ; } ; } ; } ; }
parameters : { path : { orderId : number ; } ; }
path : { orderId : number ; }
responses : { 200 : { content : { application/json : null | { articleSystemId ?: null | number ; fileDataBase64 ?: null | string ; fileId ?: number ; fileName ?: null | string ; mimeType ?: null | string ; orderId ?: null | number ; purchaseOrderId ?: null | number ; } [] ; } ; } ; }
200 : { content : { application/json : null | { articleSystemId ?: null | number ; fileDataBase64 ?: null | string ; fileId ?: number ; fileName ?: null | string ; mimeType ?: null | string ; orderId ?: null | number ; purchaseOrderId ?: null | number ; } [] ; } ; }
content : { application/json : null | { articleSystemId ?: null | number ; fileDataBase64 ?: null | string ; fileId ?: number ; fileName ?: null | string ; mimeType ?: null | string ; orderId ?: null | number ; purchaseOrderId ?: null | number ; } [] ; }
application/json : null | { articleSystemId ?: null | number ; fileDataBase64 ?: null | string ; fileId ?: number ; fileName ?: null | string ; mimeType ?: null | string ; orderId ?: null | number ; purchaseOrderId ?: null | number ; } []
post : { parameters : { path : { orderId : number ; } ; } ; requestBody : { content : { application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; }
parameters : { path : { orderId : number ; } ; }
path : { orderId : number ; }
request Body : { content : { application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; } ; } ; }
content : { application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; } ; }
application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; }
Optional advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; }
Optional printing Info ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; }
Optional print As User ?: { userId ?: null | number ; }
Optional user Id ?: null | number
Optional print As Workstation ?: { workstationId ?: null | number ; }
Optional workstation Id ?: null | number
Optional report Id ?: null | number
file Data Base64 : string
file Name : string
mime Type : string
responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; }
200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; }
content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; }
application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; }
Optional file Id ?: null | number
Optional message ?: null | string
Optional success ?: boolean
put : { parameters : { path : { orderId : number ; } ; query : { fileName : null | string ; } ; } ; requestBody : { content : { application/json : { fileDataBase64 : string ; mimeType : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; }
parameters : { path : { orderId : number ; } ; query : { fileName : null | string ; } ; }
path : { orderId : number ; }
query : { fileName : null | string ; }
request Body : { content : { application/json : { fileDataBase64 : string ; mimeType : string ; } ; } ; }
content : { application/json : { fileDataBase64 : string ; mimeType : string ; } ; }
application/json : { fileDataBase64 : string ; mimeType : string ; }
file Data Base64 : string
mime Type : string
responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; }
200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; }
content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; }
application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; }
Optional file Id ?: null | number
Optional message ?: null | string
Optional success ?: boolean
/api/v1/orders/{order Id}/files/{file Id}
/api/v1/orders/{order Id}/files/{file Id} : { put : { parameters : { path : { fileId : number ; orderId : number ; } ; } ; requestBody : { content : { application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; } ; }
Type declaration
put : { parameters : { path : { fileId : number ; orderId : number ; } ; } ; requestBody : { content : { application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; }
parameters : { path : { fileId : number ; orderId : number ; } ; }
path : { fileId : number ; orderId : number ; }
file Id : number
order Id : number
request Body : { content : { application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; } ; } ; }
content : { application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; } ; }
application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; }
Optional advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; }
Optional printing Info ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; }
Optional print As User ?: { userId ?: null | number ; }
Optional user Id ?: null | number
Optional print As Workstation ?: { workstationId ?: null | number ; }
Optional workstation Id ?: null | number
Optional report Id ?: null | number
file Data Base64 : string
file Name : string
mime Type : string
responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; }
200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; }
content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; }
application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; }
Optional file Id ?: null | number
Optional message ?: null | string
Optional success ?: boolean
/api/v1/orders/{order Id}/invoice Charges
/api/v1/orders/{order Id}/invoice Charges : { get : { parameters : { path : { orderId : number ; } ; } ; responses : { 200 : { content : { application/json : null | { actionDate ?: null | string ; chargeId ?: number ; comment ?: null | string ; invoiceArticle ?: { account ?: null | string ; code ?: null | string ; invoiceArticleId ?: number ; title ?: null | string ; } ; invoiceId ?: number ; numberOfItems ?: number ; price ?: number ; profitCenter ?: { code ?: null | string ; name ?: null | string ; } ; } [] ; } ; } ; } ; } ; }
Type declaration
get : { parameters : { path : { orderId : number ; } ; } ; responses : { 200 : { content : { application/json : null | { actionDate ?: null | string ; chargeId ?: number ; comment ?: null | string ; invoiceArticle ?: { account ?: null | string ; code ?: null | string ; invoiceArticleId ?: number ; title ?: null | string ; } ; invoiceId ?: number ; numberOfItems ?: number ; price ?: number ; profitCenter ?: { code ?: null | string ; name ?: null | string ; } ; } [] ; } ; } ; } ; }
parameters : { path : { orderId : number ; } ; }
path : { orderId : number ; }
responses : { 200 : { content : { application/json : null | { actionDate ?: null | string ; chargeId ?: number ; comment ?: null | string ; invoiceArticle ?: { account ?: null | string ; code ?: null | string ; invoiceArticleId ?: number ; title ?: null | string ; } ; invoiceId ?: number ; numberOfItems ?: number ; price ?: number ; profitCenter ?: { code ?: null | string ; name ?: null | string ; } ; } [] ; } ; } ; }
200 : { content : { application/json : null | { actionDate ?: null | string ; chargeId ?: number ; comment ?: null | string ; invoiceArticle ?: { account ?: null | string ; code ?: null | string ; invoiceArticleId ?: number ; title ?: null | string ; } ; invoiceId ?: number ; numberOfItems ?: number ; price ?: number ; profitCenter ?: { code ?: null | string ; name ?: null | string ; } ; } [] ; } ; }
content : { application/json : null | { actionDate ?: null | string ; chargeId ?: number ; comment ?: null | string ; invoiceArticle ?: { account ?: null | string ; code ?: null | string ; invoiceArticleId ?: number ; title ?: null | string ; } ; invoiceId ?: number ; numberOfItems ?: number ; price ?: number ; profitCenter ?: { code ?: null | string ; name ?: null | string ; } ; } [] ; }
application/json : null | { actionDate ?: null | string ; chargeId ?: number ; comment ?: null | string ; invoiceArticle ?: { account ?: null | string ; code ?: null | string ; invoiceArticleId ?: number ; title ?: null | string ; } ; invoiceId ?: number ; numberOfItems ?: number ; price ?: number ; profitCenter ?: { code ?: null | string ; name ?: null | string ; } ; } []
/api/v1/orders/{order Id}/lines/{order Line Id}/reported Number Of Items
/api/v1/orders/{order Id}/lines/{order Line Id}/reported Number Of Items : { patch : { parameters : { path : { orderId : number ; orderLineId : number ; } ; } ; requestBody : { content : { application/json : { reportedNumberOfItems : number ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; } ; } ; }
Type declaration
patch : { parameters : { path : { orderId : number ; orderLineId : number ; } ; } ; requestBody : { content : { application/json : { reportedNumberOfItems : number ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; } ; }
parameters : { path : { orderId : number ; orderLineId : number ; } ; }
path : { orderId : number ; orderLineId : number ; }
order Id : number
order Line Id : number
request Body : { content : { application/json : { reportedNumberOfItems : number ; } ; } ; }
content : { application/json : { reportedNumberOfItems : number ; } ; }
application/json : { reportedNumberOfItems : number ; }
reported Number Of Items : number
responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; }
content : { application/json : { message ?: null | string ; orderId ?: number ; } ; }
application/json : { message ?: null | string ; orderId ?: number ; }
Optional message ?: null | string
Optional order Id ?: number
/api/v1/orders/{order Id}/lines/{order Line Id}/reported Returned Number Of Items
/api/v1/orders/{order Id}/lines/{order Line Id}/reported Returned Number Of Items : { patch : { parameters : { path : { orderId : number ; orderLineId : number ; } ; } ; requestBody : { content : { application/json : { reportedReturnedNumberOfItems : number ; } ; } ; } ; responses : { 200 : { content : { application/octet-stream : string ; } ; } ; } ; } ; }
Type declaration
patch : { parameters : { path : { orderId : number ; orderLineId : number ; } ; } ; requestBody : { content : { application/json : { reportedReturnedNumberOfItems : number ; } ; } ; } ; responses : { 200 : { content : { application/octet-stream : string ; } ; } ; } ; }
parameters : { path : { orderId : number ; orderLineId : number ; } ; }
path : { orderId : number ; orderLineId : number ; }
order Id : number
order Line Id : number
request Body : { content : { application/json : { reportedReturnedNumberOfItems : number ; } ; } ; }
content : { application/json : { reportedReturnedNumberOfItems : number ; } ; }
application/json : { reportedReturnedNumberOfItems : number ; }
reported Returned Number Of Items : number
responses : { 200 : { content : { application/octet-stream : string ; } ; } ; }
200 : { content : { application/octet-stream : string ; } ; }
content : { application/octet-stream : string ; }
application/octet- stream : string
/api/v1/orders/{order Id}/order Number
/api/v1/orders/{order Id}/order Number : { patch : { parameters : { path : { orderId : number ; } ; } ; requestBody : { content : { application/json : { orderNumber : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; } ; } ; }
Type declaration
patch : { parameters : { path : { orderId : number ; } ; } ; requestBody : { content : { application/json : { orderNumber : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; } ; }
parameters : { path : { orderId : number ; } ; }
path : { orderId : number ; }
request Body : { content : { application/json : { orderNumber : string ; } ; } ; }
content : { application/json : { orderNumber : string ; } ; }
application/json : { orderNumber : string ; }
responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; }
content : { application/json : { message ?: null | string ; orderId ?: number ; } ; }
application/json : { message ?: null | string ; orderId ?: number ; }
Optional message ?: null | string
Optional order Id ?: number
/api/v1/orders/{order Id}/order Status
/api/v1/orders/{order Id}/order Status : { patch : { parameters : { path : { orderId : number ; } ; } ; requestBody : { content : { application/json : { orderStatusNumber : number ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; } ; } ; }
Type declaration
patch : { parameters : { path : { orderId : number ; } ; } ; requestBody : { content : { application/json : { orderStatusNumber : number ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; } ; }
parameters : { path : { orderId : number ; } ; }
path : { orderId : number ; }
request Body : { content : { application/json : { orderStatusNumber : number ; } ; } ; }
content : { application/json : { orderStatusNumber : number ; } ; }
application/json : { orderStatusNumber : number ; }
order Status Number : number
responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; }
content : { application/json : { message ?: null | string ; orderId ?: number ; } ; }
application/json : { message ?: null | string ; orderId ?: number ; }
Optional message ?: null | string
Optional order Id ?: number
/api/v1/orders/{order Id}/order Tracking
/api/v1/orders/{order Id}/order Tracking : { put : { parameters : { path : { orderId : number ; } ; } ; requestBody : { content : { application/json : { isReturnTracking : boolean ; trackingUrl : string ; waybill : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; } ; }
Type declaration
put : { parameters : { path : { orderId : number ; } ; } ; requestBody : { content : { application/json : { isReturnTracking : boolean ; trackingUrl : string ; waybill : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; }
parameters : { path : { orderId : number ; } ; }
path : { orderId : number ; }
request Body : { content : { application/json : { isReturnTracking : boolean ; trackingUrl : string ; waybill : string ; } ; } ; }
content : { application/json : { isReturnTracking : boolean ; trackingUrl : string ; waybill : string ; } ; }
application/json : { isReturnTracking : boolean ; trackingUrl : string ; waybill : string ; }
is Return Tracking : boolean
tracking Url : string
waybill : string
responses : { 200 : { content : { application/json : { message ?: null | string ; success ?: boolean ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; success ?: boolean ; } ; } ; }
content : { application/json : { message ?: null | string ; success ?: boolean ; } ; }
application/json : { message ?: null | string ; success ?: boolean ; }
Optional message ?: null | string
Optional success ?: boolean
/api/v1/orders/{order Id}/parcels
/api/v1/orders/{order Id}/parcels : { put : { parameters : { path : { orderId : number ; } ; } ; requestBody : { content : { application/json : { advanced ?: { parcelStatus ?: { code ?: null | string ; id ?: null | number ; } ; parcelType ?: { code ?: null | string ; id ?: null | number ; } ; } ; parcelNumber : string ; transportAdministrationType : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; parcelId ?: number ; success ?: boolean ; } ; } ; } ; } ; } ; }
Type declaration
put : { parameters : { path : { orderId : number ; } ; } ; requestBody : { content : { application/json : { advanced ?: { parcelStatus ?: { code ?: null | string ; id ?: null | number ; } ; parcelType ?: { code ?: null | string ; id ?: null | number ; } ; } ; parcelNumber : string ; transportAdministrationType : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; parcelId ?: number ; success ?: boolean ; } ; } ; } ; } ; }
parameters : { path : { orderId : number ; } ; }
path : { orderId : number ; }
request Body : { content : { application/json : { advanced ?: { parcelStatus ?: { code ?: null | string ; id ?: null | number ; } ; parcelType ?: { code ?: null | string ; id ?: null | number ; } ; } ; parcelNumber : string ; transportAdministrationType : string ; } ; } ; }
content : { application/json : { advanced ?: { parcelStatus ?: { code ?: null | string ; id ?: null | number ; } ; parcelType ?: { code ?: null | string ; id ?: null | number ; } ; } ; parcelNumber : string ; transportAdministrationType : string ; } ; }
application/json : { advanced ?: { parcelStatus ?: { code ?: null | string ; id ?: null | number ; } ; parcelType ?: { code ?: null | string ; id ?: null | number ; } ; } ; parcelNumber : string ; transportAdministrationType : string ; }
Optional advanced ?: { parcelStatus ?: { code ?: null | string ; id ?: null | number ; } ; parcelType ?: { code ?: null | string ; id ?: null | number ; } ; }
Optional parcel Status ?: { code ?: null | string ; id ?: null | number ; }
Optional code ?: null | string
Optional id ?: null | number
Optional parcel Type ?: { code ?: null | string ; id ?: null | number ; }
Optional code ?: null | string
Optional id ?: null | number
parcel Number : string
transport Administration Type : string
responses : { 200 : { content : { application/json : { message ?: null | string ; parcelId ?: number ; success ?: boolean ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; parcelId ?: number ; success ?: boolean ; } ; } ; }
content : { application/json : { message ?: null | string ; parcelId ?: number ; success ?: boolean ; } ; }
application/json : { message ?: null | string ; parcelId ?: number ; success ?: boolean ; }
Optional message ?: null | string
Optional parcel Id ?: number
Optional success ?: boolean
/api/v1/orders/{order Id}/parcels/{parcel Id}
/api/v1/orders/{order Id}/parcels/{parcel Id} : { delete : { parameters : { path : { orderId : number ; parcelId : number ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; parcelId ?: number ; success ?: boolean ; } ; } ; } ; } ; } ; put : { parameters : { path : { orderId : number ; parcelId : number ; } ; } ; requestBody : { content : { application/json : { advanced ?: { parcelStatus ?: { code ?: null | string ; id ?: null | number ; } ; parcelType ?: { code ?: null | string ; id ?: null | number ; } ; } ; parcelNumber ?: null | string ; transportAdministrationType ?: null | string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; parcelId ?: number ; success ?: boolean ; } ; } ; } ; } ; } ; }
Type declaration
delete : { parameters : { path : { orderId : number ; parcelId : number ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; parcelId ?: number ; success ?: boolean ; } ; } ; } ; } ; }
parameters : { path : { orderId : number ; parcelId : number ; } ; }
path : { orderId : number ; parcelId : number ; }
order Id : number
parcel Id : number
responses : { 200 : { content : { application/json : { message ?: null | string ; parcelId ?: number ; success ?: boolean ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; parcelId ?: number ; success ?: boolean ; } ; } ; }
content : { application/json : { message ?: null | string ; parcelId ?: number ; success ?: boolean ; } ; }
application/json : { message ?: null | string ; parcelId ?: number ; success ?: boolean ; }
Optional message ?: null | string
Optional parcel Id ?: number
Optional success ?: boolean
put : { parameters : { path : { orderId : number ; parcelId : number ; } ; } ; requestBody : { content : { application/json : { advanced ?: { parcelStatus ?: { code ?: null | string ; id ?: null | number ; } ; parcelType ?: { code ?: null | string ; id ?: null | number ; } ; } ; parcelNumber ?: null | string ; transportAdministrationType ?: null | string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; parcelId ?: number ; success ?: boolean ; } ; } ; } ; } ; }
parameters : { path : { orderId : number ; parcelId : number ; } ; }
path : { orderId : number ; parcelId : number ; }
order Id : number
parcel Id : number
request Body : { content : { application/json : { advanced ?: { parcelStatus ?: { code ?: null | string ; id ?: null | number ; } ; parcelType ?: { code ?: null | string ; id ?: null | number ; } ; } ; parcelNumber ?: null | string ; transportAdministrationType ?: null | string ; } ; } ; }
content : { application/json : { advanced ?: { parcelStatus ?: { code ?: null | string ; id ?: null | number ; } ; parcelType ?: { code ?: null | string ; id ?: null | number ; } ; } ; parcelNumber ?: null | string ; transportAdministrationType ?: null | string ; } ; }
application/json : { advanced ?: { parcelStatus ?: { code ?: null | string ; id ?: null | number ; } ; parcelType ?: { code ?: null | string ; id ?: null | number ; } ; } ; parcelNumber ?: null | string ; transportAdministrationType ?: null | string ; }
Optional advanced ?: { parcelStatus ?: { code ?: null | string ; id ?: null | number ; } ; parcelType ?: { code ?: null | string ; id ?: null | number ; } ; }
Optional parcel Status ?: { code ?: null | string ; id ?: null | number ; }
Optional code ?: null | string
Optional id ?: null | number
Optional parcel Type ?: { code ?: null | string ; id ?: null | number ; }
Optional code ?: null | string
Optional id ?: null | number
Optional parcel Number ?: null | string
Optional transport Administration Type ?: null | string
responses : { 200 : { content : { application/json : { message ?: null | string ; parcelId ?: number ; success ?: boolean ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; parcelId ?: number ; success ?: boolean ; } ; } ; }
content : { application/json : { message ?: null | string ; parcelId ?: number ; success ?: boolean ; } ; }
application/json : { message ?: null | string ; parcelId ?: number ; success ?: boolean ; }
Optional message ?: null | string
Optional parcel Id ?: number
Optional success ?: boolean
/api/v1/orders/{order Id}/return Waybill
/api/v1/orders/{order Id}/return Waybill : { patch : { parameters : { path : { orderId : number ; } ; } ; requestBody : { content : { application/json : { returnWaybill : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; } ; } ; }
Type declaration
patch : { parameters : { path : { orderId : number ; } ; } ; requestBody : { content : { application/json : { returnWaybill : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; } ; }
parameters : { path : { orderId : number ; } ; }
path : { orderId : number ; }
request Body : { content : { application/json : { returnWaybill : string ; } ; } ; }
content : { application/json : { returnWaybill : string ; } ; }
application/json : { returnWaybill : string ; }
responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; }
content : { application/json : { message ?: null | string ; orderId ?: number ; } ; }
application/json : { message ?: null | string ; orderId ?: number ; }
Optional message ?: null | string
Optional order Id ?: number
/api/v1/orders/{order Id}/service Point Code
/api/v1/orders/{order Id}/service Point Code : { patch : { parameters : { path : { orderId : number ; } ; } ; requestBody : { content : { application/json : { servicePointCode : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; } ; } ; }
Type declaration
patch : { parameters : { path : { orderId : number ; } ; } ; requestBody : { content : { application/json : { servicePointCode : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; } ; }
parameters : { path : { orderId : number ; } ; }
path : { orderId : number ; }
request Body : { content : { application/json : { servicePointCode : string ; } ; } ; }
content : { application/json : { servicePointCode : string ; } ; }
application/json : { servicePointCode : string ; }
responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; }
content : { application/json : { message ?: null | string ; orderId ?: number ; } ; }
application/json : { message ?: null | string ; orderId ?: number ; }
Optional message ?: null | string
Optional order Id ?: number
/api/v1/orders/{order Id}/set Order Classes
/api/v1/orders/{order Id}/set Order Classes : { patch : { parameters : { path : { orderId : number ; } ; } ; requestBody : { content : { application/json : { classes ?: null | { code ?: null | string ; comment ?: null | string ; name ?: null | string ; } [] ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; } ; } ; }
Type declaration
patch : { parameters : { path : { orderId : number ; } ; } ; requestBody : { content : { application/json : { classes ?: null | { code ?: null | string ; comment ?: null | string ; name ?: null | string ; } [] ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; } ; }
parameters : { path : { orderId : number ; } ; }
path : { orderId : number ; }
request Body : { content : { application/json : { classes ?: null | { code ?: null | string ; comment ?: null | string ; name ?: null | string ; } [] ; } ; } ; }
content : { application/json : { classes ?: null | { code ?: null | string ; comment ?: null | string ; name ?: null | string ; } [] ; } ; }
application/json : { classes ?: null | { code ?: null | string ; comment ?: null | string ; name ?: null | string ; } [] ; }
Optional classes ?: null | { code ?: null | string ; comment ?: null | string ; name ?: null | string ; } []
responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; }
content : { application/json : { message ?: null | string ; orderId ?: number ; } ; }
application/json : { message ?: null | string ; orderId ?: number ; }
Optional message ?: null | string
Optional order Id ?: number
/api/v1/orders/{order Id}/set Reported Number Of Items To Picked Number Of Items
/api/v1/orders/{order Id}/set Reported Number Of Items To Picked Number Of Items : { patch : { parameters : { path : { orderId : number ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; } ; } ; }
Type declaration
patch : { parameters : { path : { orderId : number ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; } ; }
parameters : { path : { orderId : number ; } ; }
path : { orderId : number ; }
responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; }
content : { application/json : { message ?: null | string ; orderId ?: number ; } ; }
application/json : { message ?: null | string ; orderId ?: number ; }
Optional message ?: null | string
Optional order Id ?: number
/api/v1/orders/{order Id}/set Reported Returned Number Of Items To Returned Number Of Items
/api/v1/orders/{order Id}/set Reported Returned Number Of Items To Returned Number Of Items : { patch : { parameters : { path : { orderId : number ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; } ; } ; }
Type declaration
patch : { parameters : { path : { orderId : number ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; } ; }
parameters : { path : { orderId : number ; } ; }
path : { orderId : number ; }
responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; }
content : { application/json : { message ?: null | string ; orderId ?: number ; } ; }
application/json : { message ?: null | string ; orderId ?: number ; }
Optional message ?: null | string
Optional order Id ?: number
/api/v1/orders/{order Id}/transporter
/api/v1/orders/{order Id}/transporter : { patch : { parameters : { path : { orderId : number ; } ; } ; requestBody : { content : { application/json : { paymentAdvanced ?: { consigneeCollects ?: null | boolean ; consigneePays ?: { customerNumber : string ; } ; thirdPartyPays ?: { customerNumber : string ; } ; } ; transporterCode ?: null | string ; transporterServiceCode ?: null | string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; } ; } ; }
Type declaration
patch : { parameters : { path : { orderId : number ; } ; } ; requestBody : { content : { application/json : { paymentAdvanced ?: { consigneeCollects ?: null | boolean ; consigneePays ?: { customerNumber : string ; } ; thirdPartyPays ?: { customerNumber : string ; } ; } ; transporterCode ?: null | string ; transporterServiceCode ?: null | string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; } ; }
parameters : { path : { orderId : number ; } ; }
path : { orderId : number ; }
request Body : { content : { application/json : { paymentAdvanced ?: { consigneeCollects ?: null | boolean ; consigneePays ?: { customerNumber : string ; } ; thirdPartyPays ?: { customerNumber : string ; } ; } ; transporterCode ?: null | string ; transporterServiceCode ?: null | string ; } ; } ; }
content : { application/json : { paymentAdvanced ?: { consigneeCollects ?: null | boolean ; consigneePays ?: { customerNumber : string ; } ; thirdPartyPays ?: { customerNumber : string ; } ; } ; transporterCode ?: null | string ; transporterServiceCode ?: null | string ; } ; }
application/json : { paymentAdvanced ?: { consigneeCollects ?: null | boolean ; consigneePays ?: { customerNumber : string ; } ; thirdPartyPays ?: { customerNumber : string ; } ; } ; transporterCode ?: null | string ; transporterServiceCode ?: null | string ; }
Optional payment Advanced ?: { consigneeCollects ?: null | boolean ; consigneePays ?: { customerNumber : string ; } ; thirdPartyPays ?: { customerNumber : string ; } ; }
Optional consignee Collects ?: null | boolean
Optional consignee Pays ?: { customerNumber : string ; }
Optional third Party Pays ?: { customerNumber : string ; }
Optional transporter Code ?: null | string
Optional transporter Service Code ?: null | string
responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; }
content : { application/json : { message ?: null | string ; orderId ?: number ; } ; }
application/json : { message ?: null | string ; orderId ?: number ; }
Optional message ?: null | string
Optional order Id ?: number
/api/v1/orders/{order Id}/way Bill Rows
/api/v1/orders/{order Id}/way Bill Rows : { get : { parameters : { path : { orderId : number ; } ; } ; responses : { 200 : { content : { application/json : null | { approvedNumberOfPackages ?: null | number ; category ?: null | string ; comment ?: null | string ; height ?: null | number ; length ?: null | number ; numberOfPackages ?: number ; parcelType ?: { barCode ?: null | string ; code ?: null | string ; height ?: null | number ; length ?: null | number ; loadMeters ?: null | number ; name ?: null | string ; weight ?: null | number ; width ?: null | number ; } ; volume ?: null | number ; wayBillRowId ?: number ; weight ?: null | number ; width ?: null | number ; } [] ; } ; } ; } ; } ; post : { parameters : { path : { orderId : number ; } ; } ; requestBody : { content : { application/json : { approvedNumberOfPackages ?: null | number ; category ?: null | string ; comment ?: null | string ; height ?: null | number ; length ?: null | number ; loadMeters ?: null | number ; numberOfPackages : number ; parcelType : { code ?: null | string ; id ?: null | number ; } ; volume ?: null | number ; weight ?: null | number ; width ?: null | number ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; success ?: boolean ; wayBillRowId ?: number ; } ; } ; } ; } ; } ; }
Type declaration
get : { parameters : { path : { orderId : number ; } ; } ; responses : { 200 : { content : { application/json : null | { approvedNumberOfPackages ?: null | number ; category ?: null | string ; comment ?: null | string ; height ?: null | number ; length ?: null | number ; numberOfPackages ?: number ; parcelType ?: { barCode ?: null | string ; code ?: null | string ; height ?: null | number ; length ?: null | number ; loadMeters ?: null | number ; name ?: null | string ; weight ?: null | number ; width ?: null | number ; } ; volume ?: null | number ; wayBillRowId ?: number ; weight ?: null | number ; width ?: null | number ; } [] ; } ; } ; } ; }
parameters : { path : { orderId : number ; } ; }
path : { orderId : number ; }
responses : { 200 : { content : { application/json : null | { approvedNumberOfPackages ?: null | number ; category ?: null | string ; comment ?: null | string ; height ?: null | number ; length ?: null | number ; numberOfPackages ?: number ; parcelType ?: { barCode ?: null | string ; code ?: null | string ; height ?: null | number ; length ?: null | number ; loadMeters ?: null | number ; name ?: null | string ; weight ?: null | number ; width ?: null | number ; } ; volume ?: null | number ; wayBillRowId ?: number ; weight ?: null | number ; width ?: null | number ; } [] ; } ; } ; }
200 : { content : { application/json : null | { approvedNumberOfPackages ?: null | number ; category ?: null | string ; comment ?: null | string ; height ?: null | number ; length ?: null | number ; numberOfPackages ?: number ; parcelType ?: { barCode ?: null | string ; code ?: null | string ; height ?: null | number ; length ?: null | number ; loadMeters ?: null | number ; name ?: null | string ; weight ?: null | number ; width ?: null | number ; } ; volume ?: null | number ; wayBillRowId ?: number ; weight ?: null | number ; width ?: null | number ; } [] ; } ; }
content : { application/json : null | { approvedNumberOfPackages ?: null | number ; category ?: null | string ; comment ?: null | string ; height ?: null | number ; length ?: null | number ; numberOfPackages ?: number ; parcelType ?: { barCode ?: null | string ; code ?: null | string ; height ?: null | number ; length ?: null | number ; loadMeters ?: null | number ; name ?: null | string ; weight ?: null | number ; width ?: null | number ; } ; volume ?: null | number ; wayBillRowId ?: number ; weight ?: null | number ; width ?: null | number ; } [] ; }
application/json : null | { approvedNumberOfPackages ?: null | number ; category ?: null | string ; comment ?: null | string ; height ?: null | number ; length ?: null | number ; numberOfPackages ?: number ; parcelType ?: { barCode ?: null | string ; code ?: null | string ; height ?: null | number ; length ?: null | number ; loadMeters ?: null | number ; name ?: null | string ; weight ?: null | number ; width ?: null | number ; } ; volume ?: null | number ; wayBillRowId ?: number ; weight ?: null | number ; width ?: null | number ; } []
post : { parameters : { path : { orderId : number ; } ; } ; requestBody : { content : { application/json : { approvedNumberOfPackages ?: null | number ; category ?: null | string ; comment ?: null | string ; height ?: null | number ; length ?: null | number ; loadMeters ?: null | number ; numberOfPackages : number ; parcelType : { code ?: null | string ; id ?: null | number ; } ; volume ?: null | number ; weight ?: null | number ; width ?: null | number ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; success ?: boolean ; wayBillRowId ?: number ; } ; } ; } ; } ; }
parameters : { path : { orderId : number ; } ; }
path : { orderId : number ; }
request Body : { content : { application/json : { approvedNumberOfPackages ?: null | number ; category ?: null | string ; comment ?: null | string ; height ?: null | number ; length ?: null | number ; loadMeters ?: null | number ; numberOfPackages : number ; parcelType : { code ?: null | string ; id ?: null | number ; } ; volume ?: null | number ; weight ?: null | number ; width ?: null | number ; } ; } ; }
content : { application/json : { approvedNumberOfPackages ?: null | number ; category ?: null | string ; comment ?: null | string ; height ?: null | number ; length ?: null | number ; loadMeters ?: null | number ; numberOfPackages : number ; parcelType : { code ?: null | string ; id ?: null | number ; } ; volume ?: null | number ; weight ?: null | number ; width ?: null | number ; } ; }
application/json : { approvedNumberOfPackages ?: null | number ; category ?: null | string ; comment ?: null | string ; height ?: null | number ; length ?: null | number ; loadMeters ?: null | number ; numberOfPackages : number ; parcelType : { code ?: null | string ; id ?: null | number ; } ; volume ?: null | number ; weight ?: null | number ; width ?: null | number ; }
Optional approved Number Of Packages ?: null | number
Optional category ?: null | string
Optional comment ?: null | string
Optional height ?: null | number
Optional length ?: null | number
Optional load Meters ?: null | number
number Of Packages : number
parcel Type : { code ?: null | string ; id ?: null | number ; }
Optional code ?: null | string
Optional id ?: null | number
Optional volume ?: null | number
Optional weight ?: null | number
Optional width ?: null | number
responses : { 200 : { content : { application/json : { message ?: null | string ; success ?: boolean ; wayBillRowId ?: number ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; success ?: boolean ; wayBillRowId ?: number ; } ; } ; }
content : { application/json : { message ?: null | string ; success ?: boolean ; wayBillRowId ?: number ; } ; }
application/json : { message ?: null | string ; success ?: boolean ; wayBillRowId ?: number ; }
Optional message ?: null | string
Optional success ?: boolean
Optional way Bill Row Id ?: number
/api/v1/orders/{order Id}/way Bill Rows/{way Bill Row Id}
/api/v1/orders/{order Id}/way Bill Rows/{way Bill Row Id} : { delete : { parameters : { path : { orderId : number ; wayBillRowId : number ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; parcelId ?: number ; success ?: boolean ; } ; } ; } ; } ; } ; patch : { parameters : { path : { orderId : number ; wayBillRowId : number ; } ; } ; requestBody : { content : { application/json : { approvedNumberOfPackages ?: null | number ; category ?: null | string ; comment ?: null | string ; height ?: null | number ; length ?: null | number ; loadMeters ?: null | number ; numberOfPackages : number ; parcelType : { code ?: null | string ; id ?: null | number ; } ; volume ?: null | number ; weight ?: null | number ; width ?: null | number ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; success ?: boolean ; wayBillRowId ?: number ; } ; } ; } ; } ; } ; }
Type declaration
delete : { parameters : { path : { orderId : number ; wayBillRowId : number ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; parcelId ?: number ; success ?: boolean ; } ; } ; } ; } ; }
parameters : { path : { orderId : number ; wayBillRowId : number ; } ; }
path : { orderId : number ; wayBillRowId : number ; }
order Id : number
way Bill Row Id : number
responses : { 200 : { content : { application/json : { message ?: null | string ; parcelId ?: number ; success ?: boolean ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; parcelId ?: number ; success ?: boolean ; } ; } ; }
content : { application/json : { message ?: null | string ; parcelId ?: number ; success ?: boolean ; } ; }
application/json : { message ?: null | string ; parcelId ?: number ; success ?: boolean ; }
Optional message ?: null | string
Optional parcel Id ?: number
Optional success ?: boolean
patch : { parameters : { path : { orderId : number ; wayBillRowId : number ; } ; } ; requestBody : { content : { application/json : { approvedNumberOfPackages ?: null | number ; category ?: null | string ; comment ?: null | string ; height ?: null | number ; length ?: null | number ; loadMeters ?: null | number ; numberOfPackages : number ; parcelType : { code ?: null | string ; id ?: null | number ; } ; volume ?: null | number ; weight ?: null | number ; width ?: null | number ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; success ?: boolean ; wayBillRowId ?: number ; } ; } ; } ; } ; }
parameters : { path : { orderId : number ; wayBillRowId : number ; } ; }
path : { orderId : number ; wayBillRowId : number ; }
order Id : number
way Bill Row Id : number
request Body : { content : { application/json : { approvedNumberOfPackages ?: null | number ; category ?: null | string ; comment ?: null | string ; height ?: null | number ; length ?: null | number ; loadMeters ?: null | number ; numberOfPackages : number ; parcelType : { code ?: null | string ; id ?: null | number ; } ; volume ?: null | number ; weight ?: null | number ; width ?: null | number ; } ; } ; }
content : { application/json : { approvedNumberOfPackages ?: null | number ; category ?: null | string ; comment ?: null | string ; height ?: null | number ; length ?: null | number ; loadMeters ?: null | number ; numberOfPackages : number ; parcelType : { code ?: null | string ; id ?: null | number ; } ; volume ?: null | number ; weight ?: null | number ; width ?: null | number ; } ; }
application/json : { approvedNumberOfPackages ?: null | number ; category ?: null | string ; comment ?: null | string ; height ?: null | number ; length ?: null | number ; loadMeters ?: null | number ; numberOfPackages : number ; parcelType : { code ?: null | string ; id ?: null | number ; } ; volume ?: null | number ; weight ?: null | number ; width ?: null | number ; }
Optional approved Number Of Packages ?: null | number
Optional category ?: null | string
Optional comment ?: null | string
Optional height ?: null | number
Optional length ?: null | number
Optional load Meters ?: null | number
number Of Packages : number
parcel Type : { code ?: null | string ; id ?: null | number ; }
Optional code ?: null | string
Optional id ?: null | number
Optional volume ?: null | number
Optional weight ?: null | number
Optional width ?: null | number
responses : { 200 : { content : { application/json : { message ?: null | string ; success ?: boolean ; wayBillRowId ?: number ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; success ?: boolean ; wayBillRowId ?: number ; } ; } ; }
content : { application/json : { message ?: null | string ; success ?: boolean ; wayBillRowId ?: number ; } ; }
application/json : { message ?: null | string ; success ?: boolean ; wayBillRowId ?: number ; }
Optional message ?: null | string
Optional success ?: boolean
Optional way Bill Row Id ?: number
/api/v1/orders/{order Id}/waybill
/api/v1/orders/{order Id}/waybill : { patch : { parameters : { path : { orderId : number ; } ; } ; requestBody : { content : { application/json : { waybill : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; } ; } ; }
Type declaration
patch : { parameters : { path : { orderId : number ; } ; } ; requestBody : { content : { application/json : { waybill : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; } ; }
parameters : { path : { orderId : number ; } ; }
path : { orderId : number ; }
request Body : { content : { application/json : { waybill : string ; } ; } ; }
content : { application/json : { waybill : string ; } ; }
application/json : { waybill : string ; }
responses : { 200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; orderId ?: number ; } ; } ; }
content : { application/json : { message ?: null | string ; orderId ?: number ; } ; }
application/json : { message ?: null | string ; orderId ?: number ; }
Optional message ?: null | string
Optional order Id ?: number
/api/v1/parcel Types
/api/v1/parcel Types : { get : { parameters : { query : { goodsOwnerId : number ; } ; } ; responses : { 200 : { content : { application/json : null | { area ?: null | number ; barCode ?: null | string ; code ?: null | string ; height ?: null | number ; id ?: number ; length ?: null | number ; loadMeters ?: null | number ; name ?: null | string ; weight ?: null | number ; width ?: null | number ; } [] ; } ; } ; } ; } ; }
Type declaration
get : { parameters : { query : { goodsOwnerId : number ; } ; } ; responses : { 200 : { content : { application/json : null | { area ?: null | number ; barCode ?: null | string ; code ?: null | string ; height ?: null | number ; id ?: number ; length ?: null | number ; loadMeters ?: null | number ; name ?: null | string ; weight ?: null | number ; width ?: null | number ; } [] ; } ; } ; } ; }
parameters : { query : { goodsOwnerId : number ; } ; }
query : { goodsOwnerId : number ; }
responses : { 200 : { content : { application/json : null | { area ?: null | number ; barCode ?: null | string ; code ?: null | string ; height ?: null | number ; id ?: number ; length ?: null | number ; loadMeters ?: null | number ; name ?: null | string ; weight ?: null | number ; width ?: null | number ; } [] ; } ; } ; }
200 : { content : { application/json : null | { area ?: null | number ; barCode ?: null | string ; code ?: null | string ; height ?: null | number ; id ?: number ; length ?: null | number ; loadMeters ?: null | number ; name ?: null | string ; weight ?: null | number ; width ?: null | number ; } [] ; } ; }
content : { application/json : null | { area ?: null | number ; barCode ?: null | string ; code ?: null | string ; height ?: null | number ; id ?: number ; length ?: null | number ; loadMeters ?: null | number ; name ?: null | string ; weight ?: null | number ; width ?: null | number ; } [] ; }
application/json : null | { area ?: null | number ; barCode ?: null | string ; code ?: null | string ; height ?: null | number ; id ?: number ; length ?: null | number ; loadMeters ?: null | number ; name ?: null | string ; weight ?: null | number ; width ?: null | number ; } []
/api/v1/purchase Orders
/api/v1/purchase Orders : { delete : { parameters : { query : { goodsOwnerId : number ; purchaseOrderNumber : null | string ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; purchaseOrderId ?: null | number ; } ; } ; } ; } ; } ; get : { parameters : { query : { articleNumbers ?: null | string [] ; goodsOwnerId : number ; inDateFrom ?: null | string ; inDateTo ?: null | string ; lastReceiveTimeFrom ?: null | string ; lastReceiveTimeTo ?: null | string ; maxPurchaseOrdersToGet ?: null | number ; onlyPurchaseOrdersWithOrderLinesToReport ?: null | boolean ; purchaseOrderIdFrom ?: null | number ; purchaseOrderNumber ?: null | string ; purchaseOrderNumbers ?: null | string [] ; purchaseOrderStatusChangedTimeFrom ?: null | string ; purchaseOrderStatusFrom ?: null | number ; purchaseOrderStatusTo ?: null | number ; } ; } ; responses : { 200 : { content : { application/json : null | { goodsOwner ?: { id ?: number ; name ?: null | string ; } ; purchaseOrderInfo ?: { advanced ?: { arrivalDate ?: null | string ; container ?: null | string ; orderDate ?: null | string ; purchaseOrderIsReturnType ?: boolean ; } ; createdDate ?: null | string ; freeValues ?: { freeBool1 ?: null | boolean ; freeBool2 ?: null | boolean ; freeDecimal1 ?: null | number ; freeDecimal2 ?: null | number ; freeText1 ?: null | string ; freeText2 ?: null | string ; freeText3 ?: null | string ; freeText4 ?: null | string ; freeText5 ?: null | string ; } ; goodsOwnerReference ?: null | string ; inDate ?: null | string ; purchaseOrderId ?: number ; purchaseOrderNumber ?: null | string ; purchaseOrderRemark ?: null | string ; purchaseOrderStatus ?: { number ?: number ; text ?: null | string ; } ; purchaseOrderType ?: { code ?: null | string ; name ?: null | string ; } ; referenceNumber ?: null | string ; supplierOrderNumber ?: null | string ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } ; purchaseOrderLines ?: null | { advisedNumberOfItems ?: number ; article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; productCode ?: null | string ; } ; articleItems ?: null | { articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batchNumber ?: null | string ; caseNumber ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; inDate ?: string ; location ?: null | string ; numberOfItems ?: number ; originalArticleItemId ?: number ; serial ?: null | string ; weight ?: null | number ; } [] ; comment ?: null | string ; externalOrderLineId ?: null | string ; freeValues ?: { freeText1 ?: null | string ; freeText2 ?: null | string ; } ; id ?: number ; lineType ?: { code ?: null | string ; name ?: null | string ; } ; receivedNumberOfItems ?: number ; reportedNumberOfItems ?: null | number ; rowNumber ?: null | string ; rowPrice ?: null | number ; subPurchaseOrderLines ?: null | ( { id?: number | undefined; rowNumber?: string | null | undefined; article?: { articleSystemId?: number | undefined; articleNumber?: string | null | undefined; articleName?: string | null | undefined; productCode?: string | ... 1 more ... | undefined; } | undefined; ... 9 more ...; freeValues?: { ...; } | undefined; }) [] ; } [] ; sellerInfo ?: { sellerName ?: null | string ; sellerNumber ?: null | string ; } ; supplierInfo ?: { supplierName ?: null | string ; supplierNumber ?: null | string ; } ; } [] ; } ; } ; } ; } ; put : { requestBody : { content : { application/json : { advanced ?: { advisedDate ?: null | string ; container ?: null | string ; orderDate ?: null | string ; purchaseOrderIsReturnType ?: null | boolean ; purchaseOrderStatusCreated ?: null | number ; } ; customsInfo ?: { termsOfDeliveryType ?: { code ?: null | string ; name ?: null | string ; } ; termsOfDeliveryTypeLocation ?: null | string ; } ; freeValues ?: { freeBoolean1 ?: null | boolean ; freeBoolean2 ?: null | boolean ; freeDecimal1 ?: null | number ; freeDecimal2 ?: null | number ; freeText1 ?: null | string ; freeText2 ?: null | string ; freeText3 ?: null | string ; freeText4 ?: null | string ; freeText5 ?: null | string ; } ; goodsOwnerId : number ; goodsOwnerReference ?: null | string ; inDate ?: null | string ; purchaseOrderLines ?: null | { articleItemStatusId ?: null | number ; articleNumber : string ; batchNumber ?: null | string ; comment ?: null | string ; currencyCode ?: null | string ; expiryDate ?: null | string ; externalOrderLineId ?: null | string ; inDate ?: null | string ; lineFreeValues ?: { freeDecimal1 ?: null | number ; freeText1 ?: null | string ; freeText2 ?: null | string ; } ; lineType ?: { code ?: null | string ; name ?: null | string ; } ; numberOfItems ?: number ; productionDate ?: null | string ; rowNumber : string ; rowPrice ?: null | number ; serialNumber ?: null | string ; } [] ; purchaseOrderNumber : string ; purchaseOrderRemark ?: null | string ; purchaseOrderType ?: { code ?: null | string ; name ?: null | string ; } ; referenceNumber ?: null | string ; sellerInfo ?: { sellerAddress ?: { address ?: null | string ; address2 ?: null | string ; address3 ?: null | string ; city ?: null | string ; countryCode ?: null | string ; countryStateCode ?: null | string ; deliveryInstruction ?: null | string ; email ?: null | string ; isVisible ?: null | boolean ; mobilePhone ?: null | string ; name ?: null | string ; notifyByEmail ?: null | boolean ; notifyBySMS ?: null | boolean ; notifyByTelephone ?: null | boolean ; postCode ?: null | string ; remark ?: null | string ; telePhone ?: null | string ; } ; sellerName ?: null | string ; sellerNumber ?: null | string ; } ; supplierInfo ?: { supplierAddress ?: { address ?: null | string ; address2 ?: null | string ; address3 ?: null | string ; city ?: null | string ; countryCode ?: null | string ; countryStateCode ?: null | string ; deliveryInstruction ?: null | string ; email ?: null | string ; isVisible ?: null | boolean ; mobilePhone ?: null | string ; name ?: null | string ; notifyByEmail ?: null | boolean ; notifyBySMS ?: null | boolean ; notifyByTelephone ?: null | boolean ; postCode ?: null | string ; remark ?: null | string ; telePhone ?: null | string ; } ; supplierName ?: null | string ; supplierNumber ?: null | string ; } ; supplierOrderNumber ?: null | string ; warehouseId ?: null | number ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; purchaseOrderId ?: null | number ; } ; } ; } ; } ; } ; }
/api/v1/purchase Orders/statuses
/api/v1/purchase Orders/statuses : { get : { responses : { 200 : { content : { application/json : { orderStatuses ?: null | { number ?: number ; text ?: null | string ; } [] ; } ; } ; } ; } ; } ; }
Type declaration
get : { responses : { 200 : { content : { application/json : { orderStatuses ?: null | { number ?: number ; text ?: null | string ; } [] ; } ; } ; } ; } ; }
responses : { 200 : { content : { application/json : { orderStatuses ?: null | { number ?: number ; text ?: null | string ; } [] ; } ; } ; } ; }
200 : { content : { application/json : { orderStatuses ?: null | { number ?: number ; text ?: null | string ; } [] ; } ; } ; }
content : { application/json : { orderStatuses ?: null | { number ?: number ; text ?: null | string ; } [] ; } ; }
application/json : { orderStatuses ?: null | { number ?: number ; text ?: null | string ; } [] ; }
Optional order Statuses ?: null | { number ?: number ; text ?: null | string ; } []
/api/v1/purchase Orders/types
/api/v1/purchase Orders/types : { get : { parameters : { query : { goodsOwnerId : number ; } ; } ; responses : { 200 : { content : { application/json : { purchaseOrderTypes ?: null | ( { code ?: null | string ; name ?: null | string ; } & Record < string , never > ) [] ; } ; } ; } ; } ; } ; }
Type declaration
get : { parameters : { query : { goodsOwnerId : number ; } ; } ; responses : { 200 : { content : { application/json : { purchaseOrderTypes ?: null | ( { code ?: null | string ; name ?: null | string ; } & Record < string , never > ) [] ; } ; } ; } ; } ; }
parameters : { query : { goodsOwnerId : number ; } ; }
query : { goodsOwnerId : number ; }
responses : { 200 : { content : { application/json : { purchaseOrderTypes ?: null | ( { code ?: null | string ; name ?: null | string ; } & Record < string , never > ) [] ; } ; } ; } ; }
200 : { content : { application/json : { purchaseOrderTypes ?: null | ( { code ?: null | string ; name ?: null | string ; } & Record < string , never > ) [] ; } ; } ; }
content : { application/json : { purchaseOrderTypes ?: null | ( { code ?: null | string ; name ?: null | string ; } & Record < string , never > ) [] ; } ; }
application/json : { purchaseOrderTypes ?: null | ( { code ?: null | string ; name ?: null | string ; } & Record < string , never > ) [] ; }
Optional purchase Order Types ?: null | ( { code ?: null | string ; name ?: null | string ; } & Record < string , never > ) []
/api/v1/purchase Orders/{purchase Order Id}
/api/v1/purchase Orders/{purchase Order Id} : { delete : { parameters : { path : { purchaseOrderId : number ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; purchaseOrderId ?: null | number ; } ; } ; } ; } ; } ; get : { parameters : { path : { purchaseOrderId : number ; } ; } ; responses : { 200 : { content : { application/json : { goodsOwner ?: { id ?: number ; name ?: null | string ; } ; purchaseOrderInfo ?: { advanced ?: { arrivalDate ?: null | string ; container ?: null | string ; orderDate ?: null | string ; purchaseOrderIsReturnType ?: boolean ; } ; createdDate ?: null | string ; freeValues ?: { freeBool1 ?: null | boolean ; freeBool2 ?: null | boolean ; freeDecimal1 ?: null | number ; freeDecimal2 ?: null | number ; freeText1 ?: null | string ; freeText2 ?: null | string ; freeText3 ?: null | string ; freeText4 ?: null | string ; freeText5 ?: null | string ; } ; goodsOwnerReference ?: null | string ; inDate ?: null | string ; purchaseOrderId ?: number ; purchaseOrderNumber ?: null | string ; purchaseOrderRemark ?: null | string ; purchaseOrderStatus ?: { number ?: number ; text ?: null | string ; } ; purchaseOrderType ?: { code ?: null | string ; name ?: null | string ; } ; referenceNumber ?: null | string ; supplierOrderNumber ?: null | string ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } ; purchaseOrderLines ?: null | { advisedNumberOfItems ?: number ; article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; productCode ?: null | string ; } ; articleItems ?: null | { articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batchNumber ?: null | string ; caseNumber ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; inDate ?: string ; location ?: null | string ; numberOfItems ?: number ; originalArticleItemId ?: number ; serial ?: null | string ; weight ?: null | number ; } [] ; comment ?: null | string ; externalOrderLineId ?: null | string ; freeValues ?: { freeText1 ?: null | string ; freeText2 ?: null | string ; } ; id ?: number ; lineType ?: { code ?: null | string ; name ?: null | string ; } ; receivedNumberOfItems ?: number ; reportedNumberOfItems ?: null | number ; rowNumber ?: null | string ; rowPrice ?: null | number ; subPurchaseOrderLines ?: null | ( { id?: number | undefined; rowNumber?: string | null | undefined; article?: { articleSystemId?: number | undefined; articleNumber?: string | null | undefined; articleName?: string | null | undefined; productCode?: string | ... 1 more ... | undefined; } | undefined; ... 9 more ...; freeValues?: { ...; } | undefined; }) [] ; } [] ; sellerInfo ?: { sellerName ?: null | string ; sellerNumber ?: null | string ; } ; supplierInfo ?: { supplierName ?: null | string ; supplierNumber ?: null | string ; } ; } ; } ; } ; } ; } ; put : { parameters : { path : { purchaseOrderId : number ; } ; } ; requestBody : { content : { application/json : { advanced ?: { advisedDate ?: null | string ; container ?: null | string ; orderDate ?: null | string ; purchaseOrderIsReturnType ?: null | boolean ; purchaseOrderStatusCreated ?: null | number ; } ; customsInfo ?: { termsOfDeliveryType ?: { code ?: null | string ; name ?: null | string ; } ; termsOfDeliveryTypeLocation ?: null | string ; } ; freeValues ?: { freeBoolean1 ?: null | boolean ; freeBoolean2 ?: null | boolean ; freeDecimal1 ?: null | number ; freeDecimal2 ?: null | number ; freeText1 ?: null | string ; freeText2 ?: null | string ; freeText3 ?: null | string ; freeText4 ?: null | string ; freeText5 ?: null | string ; } ; goodsOwnerId : number ; goodsOwnerReference ?: null | string ; inDate ?: null | string ; purchaseOrderLines ?: null | { articleItemStatusId ?: null | number ; articleNumber : string ; batchNumber ?: null | string ; comment ?: null | string ; currencyCode ?: null | string ; expiryDate ?: null | string ; externalOrderLineId ?: null | string ; inDate ?: null | string ; lineFreeValues ?: { freeDecimal1 ?: null | number ; freeText1 ?: null | string ; freeText2 ?: null | string ; } ; lineType ?: { code ?: null | string ; name ?: null | string ; } ; numberOfItems ?: number ; productionDate ?: null | string ; rowNumber : string ; rowPrice ?: null | number ; serialNumber ?: null | string ; } [] ; purchaseOrderNumber : string ; purchaseOrderRemark ?: null | string ; purchaseOrderType ?: { code ?: null | string ; name ?: null | string ; } ; referenceNumber ?: null | string ; sellerInfo ?: { sellerAddress ?: { address ?: null | string ; address2 ?: null | string ; address3 ?: null | string ; city ?: null | string ; countryCode ?: null | string ; countryStateCode ?: null | string ; deliveryInstruction ?: null | string ; email ?: null | string ; isVisible ?: null | boolean ; mobilePhone ?: null | string ; name ?: null | string ; notifyByEmail ?: null | boolean ; notifyBySMS ?: null | boolean ; notifyByTelephone ?: null | boolean ; postCode ?: null | string ; remark ?: null | string ; telePhone ?: null | string ; } ; sellerName ?: null | string ; sellerNumber ?: null | string ; } ; supplierInfo ?: { supplierAddress ?: { address ?: null | string ; address2 ?: null | string ; address3 ?: null | string ; city ?: null | string ; countryCode ?: null | string ; countryStateCode ?: null | string ; deliveryInstruction ?: null | string ; email ?: null | string ; isVisible ?: null | boolean ; mobilePhone ?: null | string ; name ?: null | string ; notifyByEmail ?: null | boolean ; notifyBySMS ?: null | boolean ; notifyByTelephone ?: null | boolean ; postCode ?: null | string ; remark ?: null | string ; telePhone ?: null | string ; } ; supplierName ?: null | string ; supplierNumber ?: null | string ; } ; supplierOrderNumber ?: null | string ; warehouseId ?: null | number ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; purchaseOrderId ?: null | number ; } ; } ; } ; } ; } ; }
/api/v1/purchase Orders/{purchase Order Id}/advised Date
/api/v1/purchase Orders/{purchase Order Id}/advised Date : { patch : { parameters : { path : { purchaseOrderId : number ; } ; } ; requestBody : { content : { application/json : { advisedDate ?: null | string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; purchaseOrderId ?: number ; } ; } ; } ; } ; } ; }
Type declaration
patch : { parameters : { path : { purchaseOrderId : number ; } ; } ; requestBody : { content : { application/json : { advisedDate ?: null | string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; purchaseOrderId ?: number ; } ; } ; } ; } ; }
parameters : { path : { purchaseOrderId : number ; } ; }
path : { purchaseOrderId : number ; }
request Body : { content : { application/json : { advisedDate ?: null | string ; } ; } ; }
content : { application/json : { advisedDate ?: null | string ; } ; }
application/json : { advisedDate ?: null | string ; }
Optional advised Date ?: null | string
responses : { 200 : { content : { application/json : { message ?: null | string ; purchaseOrderId ?: number ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; purchaseOrderId ?: number ; } ; } ; }
content : { application/json : { message ?: null | string ; purchaseOrderId ?: number ; } ; }
application/json : { message ?: null | string ; purchaseOrderId ?: number ; }
Optional message ?: null | string
Optional purchase Order Id ?: number
/api/v1/purchase Orders/{purchase Order Id}/article Items
/api/v1/purchase Orders/{purchase Order Id}/article Items : { put : { parameters : { path : { purchaseOrderId : number ; } ; } ; requestBody : { content : { application/json : { items ?: null | { batch ?: null | string ; caseNumber ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; height ?: null | number ; length ?: null | number ; numberOfItems ?: null | number ; price ?: null | number ; productionDate ?: null | string ; purchaseOrderLineId : number ; serial ?: null | string ; statusId ?: null | number ; volume ?: null | number ; weight ?: null | number ; width ?: null | number ; } [] ; } ; } ; } ; responses : { 200 : { content : { application/json : { messages ?: null | { articleItemId ?: null | number ; message ?: null | string ; purchaseOrderLineId ?: number ; success ?: boolean ; } [] ; success ?: boolean ; } ; } ; } ; } ; } ; }
Type declaration
put : { parameters : { path : { purchaseOrderId : number ; } ; } ; requestBody : { content : { application/json : { items ?: null | { batch ?: null | string ; caseNumber ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; height ?: null | number ; length ?: null | number ; numberOfItems ?: null | number ; price ?: null | number ; productionDate ?: null | string ; purchaseOrderLineId : number ; serial ?: null | string ; statusId ?: null | number ; volume ?: null | number ; weight ?: null | number ; width ?: null | number ; } [] ; } ; } ; } ; responses : { 200 : { content : { application/json : { messages ?: null | { articleItemId ?: null | number ; message ?: null | string ; purchaseOrderLineId ?: number ; success ?: boolean ; } [] ; success ?: boolean ; } ; } ; } ; } ; }
parameters : { path : { purchaseOrderId : number ; } ; }
path : { purchaseOrderId : number ; }
request Body : { content : { application/json : { items ?: null | { batch ?: null | string ; caseNumber ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; height ?: null | number ; length ?: null | number ; numberOfItems ?: null | number ; price ?: null | number ; productionDate ?: null | string ; purchaseOrderLineId : number ; serial ?: null | string ; statusId ?: null | number ; volume ?: null | number ; weight ?: null | number ; width ?: null | number ; } [] ; } ; } ; }
content : { application/json : { items ?: null | { batch ?: null | string ; caseNumber ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; height ?: null | number ; length ?: null | number ; numberOfItems ?: null | number ; price ?: null | number ; productionDate ?: null | string ; purchaseOrderLineId : number ; serial ?: null | string ; statusId ?: null | number ; volume ?: null | number ; weight ?: null | number ; width ?: null | number ; } [] ; } ; }
application/json : { items ?: null | { batch ?: null | string ; caseNumber ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; height ?: null | number ; length ?: null | number ; numberOfItems ?: null | number ; price ?: null | number ; productionDate ?: null | string ; purchaseOrderLineId : number ; serial ?: null | string ; statusId ?: null | number ; volume ?: null | number ; weight ?: null | number ; width ?: null | number ; } [] ; }
Optional items ?: null | { batch ?: null | string ; caseNumber ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; height ?: null | number ; length ?: null | number ; numberOfItems ?: null | number ; price ?: null | number ; productionDate ?: null | string ; purchaseOrderLineId : number ; serial ?: null | string ; statusId ?: null | number ; volume ?: null | number ; weight ?: null | number ; width ?: null | number ; } []
responses : { 200 : { content : { application/json : { messages ?: null | { articleItemId ?: null | number ; message ?: null | string ; purchaseOrderLineId ?: number ; success ?: boolean ; } [] ; success ?: boolean ; } ; } ; } ; }
200 : { content : { application/json : { messages ?: null | { articleItemId ?: null | number ; message ?: null | string ; purchaseOrderLineId ?: number ; success ?: boolean ; } [] ; success ?: boolean ; } ; } ; }
content : { application/json : { messages ?: null | { articleItemId ?: null | number ; message ?: null | string ; purchaseOrderLineId ?: number ; success ?: boolean ; } [] ; success ?: boolean ; } ; }
application/json : { messages ?: null | { articleItemId ?: null | number ; message ?: null | string ; purchaseOrderLineId ?: number ; success ?: boolean ; } [] ; success ?: boolean ; }
Optional messages ?: null | { articleItemId ?: null | number ; message ?: null | string ; purchaseOrderLineId ?: number ; success ?: boolean ; } []
Optional success ?: boolean
/api/v1/purchase Orders/{purchase Order Id}/files
/api/v1/purchase Orders/{purchase Order Id}/files : { get : { parameters : { path : { purchaseOrderId : number ; } ; } ; responses : { 200 : { content : { application/json : null | { articleSystemId ?: null | number ; fileDataBase64 ?: null | string ; fileId ?: number ; fileName ?: null | string ; mimeType ?: null | string ; orderId ?: null | number ; purchaseOrderId ?: null | number ; } [] ; } ; } ; } ; } ; post : { parameters : { path : { purchaseOrderId : number ; } ; } ; requestBody : { content : { application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; } ; put : { parameters : { path : { purchaseOrderId : number ; } ; query : { fileName : null | string ; } ; } ; requestBody : { content : { application/json : { fileDataBase64 : string ; mimeType : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; } ; }
Type declaration
get : { parameters : { path : { purchaseOrderId : number ; } ; } ; responses : { 200 : { content : { application/json : null | { articleSystemId ?: null | number ; fileDataBase64 ?: null | string ; fileId ?: number ; fileName ?: null | string ; mimeType ?: null | string ; orderId ?: null | number ; purchaseOrderId ?: null | number ; } [] ; } ; } ; } ; }
parameters : { path : { purchaseOrderId : number ; } ; }
path : { purchaseOrderId : number ; }
responses : { 200 : { content : { application/json : null | { articleSystemId ?: null | number ; fileDataBase64 ?: null | string ; fileId ?: number ; fileName ?: null | string ; mimeType ?: null | string ; orderId ?: null | number ; purchaseOrderId ?: null | number ; } [] ; } ; } ; }
200 : { content : { application/json : null | { articleSystemId ?: null | number ; fileDataBase64 ?: null | string ; fileId ?: number ; fileName ?: null | string ; mimeType ?: null | string ; orderId ?: null | number ; purchaseOrderId ?: null | number ; } [] ; } ; }
content : { application/json : null | { articleSystemId ?: null | number ; fileDataBase64 ?: null | string ; fileId ?: number ; fileName ?: null | string ; mimeType ?: null | string ; orderId ?: null | number ; purchaseOrderId ?: null | number ; } [] ; }
application/json : null | { articleSystemId ?: null | number ; fileDataBase64 ?: null | string ; fileId ?: number ; fileName ?: null | string ; mimeType ?: null | string ; orderId ?: null | number ; purchaseOrderId ?: null | number ; } []
post : { parameters : { path : { purchaseOrderId : number ; } ; } ; requestBody : { content : { application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; }
parameters : { path : { purchaseOrderId : number ; } ; }
path : { purchaseOrderId : number ; }
request Body : { content : { application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; } ; } ; }
content : { application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; } ; }
application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; }
Optional advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; }
Optional printing Info ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; }
Optional print As User ?: { userId ?: null | number ; }
Optional user Id ?: null | number
Optional print As Workstation ?: { workstationId ?: null | number ; }
Optional workstation Id ?: null | number
Optional report Id ?: null | number
file Data Base64 : string
file Name : string
mime Type : string
responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; }
200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; }
content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; }
application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; }
Optional file Id ?: null | number
Optional message ?: null | string
Optional success ?: boolean
put : { parameters : { path : { purchaseOrderId : number ; } ; query : { fileName : null | string ; } ; } ; requestBody : { content : { application/json : { fileDataBase64 : string ; mimeType : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; }
parameters : { path : { purchaseOrderId : number ; } ; query : { fileName : null | string ; } ; }
path : { purchaseOrderId : number ; }
query : { fileName : null | string ; }
request Body : { content : { application/json : { fileDataBase64 : string ; mimeType : string ; } ; } ; }
content : { application/json : { fileDataBase64 : string ; mimeType : string ; } ; }
application/json : { fileDataBase64 : string ; mimeType : string ; }
file Data Base64 : string
mime Type : string
responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; }
200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; }
content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; }
application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; }
Optional file Id ?: null | number
Optional message ?: null | string
Optional success ?: boolean
/api/v1/purchase Orders/{purchase Order Id}/files/{file Id}
/api/v1/purchase Orders/{purchase Order Id}/files/{file Id} : { put : { parameters : { path : { fileId : number ; purchaseOrderId : number ; } ; } ; requestBody : { content : { application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; } ; }
Type declaration
put : { parameters : { path : { fileId : number ; purchaseOrderId : number ; } ; } ; requestBody : { content : { application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; } ; }
parameters : { path : { fileId : number ; purchaseOrderId : number ; } ; }
path : { fileId : number ; purchaseOrderId : number ; }
file Id : number
purchase Order Id : number
request Body : { content : { application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; } ; } ; }
content : { application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; } ; }
application/json : { advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; } ; fileDataBase64 : string ; fileName : string ; mimeType : string ; }
Optional advanced ?: { printingInfo ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; } ; }
Optional printing Info ?: { printAsUser ?: { userId ?: null | number ; } ; printAsWorkstation ?: { workstationId ?: null | number ; } ; reportId ?: null | number ; }
Optional print As User ?: { userId ?: null | number ; }
Optional user Id ?: null | number
Optional print As Workstation ?: { workstationId ?: null | number ; }
Optional workstation Id ?: null | number
Optional report Id ?: null | number
file Data Base64 : string
file Name : string
mime Type : string
responses : { 200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; } ; }
200 : { content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; } ; }
content : { application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; } ; }
application/json : { fileId ?: null | number ; message ?: null | string ; success ?: boolean ; }
Optional file Id ?: null | number
Optional message ?: null | string
Optional success ?: boolean
/api/v1/purchase Orders/{purchase Order Id}/free Bool1
/api/v1/purchase Orders/{purchase Order Id}/free Bool1 : { patch : { parameters : { path : { purchaseOrderId : number ; } ; } ; requestBody : { content : { application/json : { freeBool1 : boolean ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; purchaseOrderId ?: number ; } ; } ; } ; } ; } ; }
Type declaration
patch : { parameters : { path : { purchaseOrderId : number ; } ; } ; requestBody : { content : { application/json : { freeBool1 : boolean ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; purchaseOrderId ?: number ; } ; } ; } ; } ; }
parameters : { path : { purchaseOrderId : number ; } ; }
path : { purchaseOrderId : number ; }
request Body : { content : { application/json : { freeBool1 : boolean ; } ; } ; }
content : { application/json : { freeBool1 : boolean ; } ; }
application/json : { freeBool1 : boolean ; }
responses : { 200 : { content : { application/json : { message ?: null | string ; purchaseOrderId ?: number ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; purchaseOrderId ?: number ; } ; } ; }
content : { application/json : { message ?: null | string ; purchaseOrderId ?: number ; } ; }
application/json : { message ?: null | string ; purchaseOrderId ?: number ; }
Optional message ?: null | string
Optional purchase Order Id ?: number
/api/v1/purchase Orders/{purchase Order Id}/in Date
/api/v1/purchase Orders/{purchase Order Id}/in Date : { patch : { parameters : { path : { purchaseOrderId : number ; } ; } ; requestBody : { content : { application/json : { inDate ?: string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; purchaseOrderId ?: number ; } ; } ; } ; } ; } ; }
Type declaration
patch : { parameters : { path : { purchaseOrderId : number ; } ; } ; requestBody : { content : { application/json : { inDate ?: string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; purchaseOrderId ?: number ; } ; } ; } ; } ; }
parameters : { path : { purchaseOrderId : number ; } ; }
path : { purchaseOrderId : number ; }
request Body : { content : { application/json : { inDate ?: string ; } ; } ; }
content : { application/json : { inDate ?: string ; } ; }
application/json : { inDate ?: string ; }
responses : { 200 : { content : { application/json : { message ?: null | string ; purchaseOrderId ?: number ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; purchaseOrderId ?: number ; } ; } ; }
content : { application/json : { message ?: null | string ; purchaseOrderId ?: number ; } ; }
application/json : { message ?: null | string ; purchaseOrderId ?: number ; }
Optional message ?: null | string
Optional purchase Order Id ?: number
/api/v1/purchase Orders/{purchase Order Id}/lines/{purchase Order Line Id}/reported Number Of Items
/api/v1/purchase Orders/{purchase Order Id}/lines/{purchase Order Line Id}/reported Number Of Items : { patch : { parameters : { path : { purchaseOrderId : number ; purchaseOrderLineId : number ; } ; } ; requestBody : { content : { application/json : { reportedNumberOfItems : number ; } ; } ; } ; responses : { 200 : { content : { application/octet-stream : string ; } ; } ; } ; } ; }
Type declaration
patch : { parameters : { path : { purchaseOrderId : number ; purchaseOrderLineId : number ; } ; } ; requestBody : { content : { application/json : { reportedNumberOfItems : number ; } ; } ; } ; responses : { 200 : { content : { application/octet-stream : string ; } ; } ; } ; }
parameters : { path : { purchaseOrderId : number ; purchaseOrderLineId : number ; } ; }
path : { purchaseOrderId : number ; purchaseOrderLineId : number ; }
purchase Order Id : number
purchase Order Line Id : number
request Body : { content : { application/json : { reportedNumberOfItems : number ; } ; } ; }
content : { application/json : { reportedNumberOfItems : number ; } ; }
application/json : { reportedNumberOfItems : number ; }
reported Number Of Items : number
responses : { 200 : { content : { application/octet-stream : string ; } ; } ; }
200 : { content : { application/octet-stream : string ; } ; }
content : { application/octet-stream : string ; }
application/octet- stream : string
/api/v1/purchase Orders/{purchase Order Id}/purchase Order Status
/api/v1/purchase Orders/{purchase Order Id}/purchase Order Status : { patch : { parameters : { path : { purchaseOrderId : number ; } ; } ; requestBody : { content : { application/json : { purchaseOrderStatusNumber : number ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; purchaseOrderId ?: number ; } ; } ; } ; } ; } ; }
Type declaration
patch : { parameters : { path : { purchaseOrderId : number ; } ; } ; requestBody : { content : { application/json : { purchaseOrderStatusNumber : number ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; purchaseOrderId ?: number ; } ; } ; } ; } ; }
parameters : { path : { purchaseOrderId : number ; } ; }
path : { purchaseOrderId : number ; }
request Body : { content : { application/json : { purchaseOrderStatusNumber : number ; } ; } ; }
content : { application/json : { purchaseOrderStatusNumber : number ; } ; }
application/json : { purchaseOrderStatusNumber : number ; }
purchase Order Status Number : number
responses : { 200 : { content : { application/json : { message ?: null | string ; purchaseOrderId ?: number ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; purchaseOrderId ?: number ; } ; } ; }
content : { application/json : { message ?: null | string ; purchaseOrderId ?: number ; } ; }
application/json : { message ?: null | string ; purchaseOrderId ?: number ; }
Optional message ?: null | string
Optional purchase Order Id ?: number
/api/v1/purchase Orders/{purchase Order Id}/set Reported Number Of Items To Received Number Of Items
/api/v1/purchase Orders/{purchase Order Id}/set Reported Number Of Items To Received Number Of Items : { patch : { parameters : { path : { purchaseOrderId : number ; } ; } ; responses : { 200 : { content : { application/octet-stream : string ; } ; } ; } ; } ; }
Type declaration
patch : { parameters : { path : { purchaseOrderId : number ; } ; } ; responses : { 200 : { content : { application/octet-stream : string ; } ; } ; } ; }
parameters : { path : { purchaseOrderId : number ; } ; }
path : { purchaseOrderId : number ; }
responses : { 200 : { content : { application/octet-stream : string ; } ; } ; }
200 : { content : { application/octet-stream : string ; } ; }
content : { application/octet-stream : string ; }
application/octet- stream : string
/api/v1/return Orders
/api/v1/return Orders : { get : { parameters : { query : { customerOrderNumbers ?: null | string [] ; goodsOwnerId : number ; goodsReturnedFromDate ?: null | string ; returnOrderNumbers ?: null | string [] ; returnOrderStatusFrom ?: null | number ; returnOrderStatusTo ?: null | number ; } ; } ; responses : { 200 : { content : { application/json : { customerOrderInfo ?: { orderId ?: number ; orderNumber ?: null | string ; } ; returnOrderInfo ?: { comment ?: null | string ; inDate ?: null | string ; returnOrderHandlingComment ?: null | string ; returnOrderId ?: number ; returnOrderNumber ?: null | string ; returnOrderStatus ?: { number ?: number ; text ?: null | string ; } ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } ; returnOrderLines ?: null | { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; } ; customerOrderLine ?: { customerOrderRowNumber ?: null | string ; orderLineId ?: number ; } ; pickedNumberOfItems ?: number ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnOrderLineId ?: number ; returnOrderRowNumber ?: null | string ; returnedArticleItems ?: null | { articleItemCategory ?: { code ?: null | string ; name ?: null | string ; } ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batch ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; isReturnRemovedByInventory ?: boolean ; numberOfItems ?: number ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnComment ?: null | string ; returnTime ?: null | string ; serial ?: null | string ; volume ?: null | number ; weight ?: null | number ; } [] ; returnedNumberOfItems ?: number ; returnedRemovedByInventoryNumberOfItems ?: number ; toBeReturnedNumberOfItems ?: number ; } [] ; } [] ; } ; } ; } ; } ; put : { requestBody : { content : { application/json : { comment ?: null | string ; customerOrder : { orderId ?: number ; } ; goodsOwnerId : number ; inDate ?: null | string ; returnOrderHandlingComment ?: null | string ; returnOrderLines : { customerOrderLine : { orderLineId ?: number ; } ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnOrderRowNumber : string ; toBeReturnedNumberOfItems : number ; } [] ; returnOrderNumber : string ; tracking ?: null | { trackingUrl ?: null | string ; waybill ?: null | string ; } [] ; warehouseId ?: null | number ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; returnOrderId ?: null | number ; } ; } ; } ; } ; } ; }
Type declaration
get : { parameters : { query : { customerOrderNumbers ?: null | string [] ; goodsOwnerId : number ; goodsReturnedFromDate ?: null | string ; returnOrderNumbers ?: null | string [] ; returnOrderStatusFrom ?: null | number ; returnOrderStatusTo ?: null | number ; } ; } ; responses : { 200 : { content : { application/json : { customerOrderInfo ?: { orderId ?: number ; orderNumber ?: null | string ; } ; returnOrderInfo ?: { comment ?: null | string ; inDate ?: null | string ; returnOrderHandlingComment ?: null | string ; returnOrderId ?: number ; returnOrderNumber ?: null | string ; returnOrderStatus ?: { number ?: number ; text ?: null | string ; } ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } ; returnOrderLines ?: null | { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; } ; customerOrderLine ?: { customerOrderRowNumber ?: null | string ; orderLineId ?: number ; } ; pickedNumberOfItems ?: number ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnOrderLineId ?: number ; returnOrderRowNumber ?: null | string ; returnedArticleItems ?: null | { articleItemCategory ?: { code ?: null | string ; name ?: null | string ; } ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batch ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; isReturnRemovedByInventory ?: boolean ; numberOfItems ?: number ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnComment ?: null | string ; returnTime ?: null | string ; serial ?: null | string ; volume ?: null | number ; weight ?: null | number ; } [] ; returnedNumberOfItems ?: number ; returnedRemovedByInventoryNumberOfItems ?: number ; toBeReturnedNumberOfItems ?: number ; } [] ; } [] ; } ; } ; } ; }
parameters : { query : { customerOrderNumbers ?: null | string [] ; goodsOwnerId : number ; goodsReturnedFromDate ?: null | string ; returnOrderNumbers ?: null | string [] ; returnOrderStatusFrom ?: null | number ; returnOrderStatusTo ?: null | number ; } ; }
query : { customerOrderNumbers ?: null | string [] ; goodsOwnerId : number ; goodsReturnedFromDate ?: null | string ; returnOrderNumbers ?: null | string [] ; returnOrderStatusFrom ?: null | number ; returnOrderStatusTo ?: null | number ; }
Optional customer Order Numbers ?: null | string []
goods Owner Id : number
Optional goods Returned From Date ?: null | string
Optional return Order Numbers ?: null | string []
Optional return Order Status From ?: null | number
Optional return Order Status To ?: null | number
responses : { 200 : { content : { application/json : { customerOrderInfo ?: { orderId ?: number ; orderNumber ?: null | string ; } ; returnOrderInfo ?: { comment ?: null | string ; inDate ?: null | string ; returnOrderHandlingComment ?: null | string ; returnOrderId ?: number ; returnOrderNumber ?: null | string ; returnOrderStatus ?: { number ?: number ; text ?: null | string ; } ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } ; returnOrderLines ?: null | { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; } ; customerOrderLine ?: { customerOrderRowNumber ?: null | string ; orderLineId ?: number ; } ; pickedNumberOfItems ?: number ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnOrderLineId ?: number ; returnOrderRowNumber ?: null | string ; returnedArticleItems ?: null | { articleItemCategory ?: { code ?: null | string ; name ?: null | string ; } ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batch ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; isReturnRemovedByInventory ?: boolean ; numberOfItems ?: number ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnComment ?: null | string ; returnTime ?: null | string ; serial ?: null | string ; volume ?: null | number ; weight ?: null | number ; } [] ; returnedNumberOfItems ?: number ; returnedRemovedByInventoryNumberOfItems ?: number ; toBeReturnedNumberOfItems ?: number ; } [] ; } [] ; } ; } ; }
200 : { content : { application/json : { customerOrderInfo ?: { orderId ?: number ; orderNumber ?: null | string ; } ; returnOrderInfo ?: { comment ?: null | string ; inDate ?: null | string ; returnOrderHandlingComment ?: null | string ; returnOrderId ?: number ; returnOrderNumber ?: null | string ; returnOrderStatus ?: { number ?: number ; text ?: null | string ; } ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } ; returnOrderLines ?: null | { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; } ; customerOrderLine ?: { customerOrderRowNumber ?: null | string ; orderLineId ?: number ; } ; pickedNumberOfItems ?: number ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnOrderLineId ?: number ; returnOrderRowNumber ?: null | string ; returnedArticleItems ?: null | { articleItemCategory ?: { code ?: null | string ; name ?: null | string ; } ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batch ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; isReturnRemovedByInventory ?: boolean ; numberOfItems ?: number ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnComment ?: null | string ; returnTime ?: null | string ; serial ?: null | string ; volume ?: null | number ; weight ?: null | number ; } [] ; returnedNumberOfItems ?: number ; returnedRemovedByInventoryNumberOfItems ?: number ; toBeReturnedNumberOfItems ?: number ; } [] ; } [] ; } ; }
content : { application/json : { customerOrderInfo ?: { orderId ?: number ; orderNumber ?: null | string ; } ; returnOrderInfo ?: { comment ?: null | string ; inDate ?: null | string ; returnOrderHandlingComment ?: null | string ; returnOrderId ?: number ; returnOrderNumber ?: null | string ; returnOrderStatus ?: { number ?: number ; text ?: null | string ; } ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } ; returnOrderLines ?: null | { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; } ; customerOrderLine ?: { customerOrderRowNumber ?: null | string ; orderLineId ?: number ; } ; pickedNumberOfItems ?: number ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnOrderLineId ?: number ; returnOrderRowNumber ?: null | string ; returnedArticleItems ?: null | { articleItemCategory ?: { code ?: null | string ; name ?: null | string ; } ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batch ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; isReturnRemovedByInventory ?: boolean ; numberOfItems ?: number ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnComment ?: null | string ; returnTime ?: null | string ; serial ?: null | string ; volume ?: null | number ; weight ?: null | number ; } [] ; returnedNumberOfItems ?: number ; returnedRemovedByInventoryNumberOfItems ?: number ; toBeReturnedNumberOfItems ?: number ; } [] ; } [] ; }
application/json : { customerOrderInfo ?: { orderId ?: number ; orderNumber ?: null | string ; } ; returnOrderInfo ?: { comment ?: null | string ; inDate ?: null | string ; returnOrderHandlingComment ?: null | string ; returnOrderId ?: number ; returnOrderNumber ?: null | string ; returnOrderStatus ?: { number ?: number ; text ?: null | string ; } ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } ; returnOrderLines ?: null | { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; } ; customerOrderLine ?: { customerOrderRowNumber ?: null | string ; orderLineId ?: number ; } ; pickedNumberOfItems ?: number ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnOrderLineId ?: number ; returnOrderRowNumber ?: null | string ; returnedArticleItems ?: null | { articleItemCategory ?: { code ?: null | string ; name ?: null | string ; } ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batch ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; isReturnRemovedByInventory ?: boolean ; numberOfItems ?: number ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnComment ?: null | string ; returnTime ?: null | string ; serial ?: null | string ; volume ?: null | number ; weight ?: null | number ; } [] ; returnedNumberOfItems ?: number ; returnedRemovedByInventoryNumberOfItems ?: number ; toBeReturnedNumberOfItems ?: number ; } [] ; } []
put : { requestBody : { content : { application/json : { comment ?: null | string ; customerOrder : { orderId ?: number ; } ; goodsOwnerId : number ; inDate ?: null | string ; returnOrderHandlingComment ?: null | string ; returnOrderLines : { customerOrderLine : { orderLineId ?: number ; } ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnOrderRowNumber : string ; toBeReturnedNumberOfItems : number ; } [] ; returnOrderNumber : string ; tracking ?: null | { trackingUrl ?: null | string ; waybill ?: null | string ; } [] ; warehouseId ?: null | number ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; returnOrderId ?: null | number ; } ; } ; } ; } ; }
request Body : { content : { application/json : { comment ?: null | string ; customerOrder : { orderId ?: number ; } ; goodsOwnerId : number ; inDate ?: null | string ; returnOrderHandlingComment ?: null | string ; returnOrderLines : { customerOrderLine : { orderLineId ?: number ; } ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnOrderRowNumber : string ; toBeReturnedNumberOfItems : number ; } [] ; returnOrderNumber : string ; tracking ?: null | { trackingUrl ?: null | string ; waybill ?: null | string ; } [] ; warehouseId ?: null | number ; } ; } ; }
content : { application/json : { comment ?: null | string ; customerOrder : { orderId ?: number ; } ; goodsOwnerId : number ; inDate ?: null | string ; returnOrderHandlingComment ?: null | string ; returnOrderLines : { customerOrderLine : { orderLineId ?: number ; } ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnOrderRowNumber : string ; toBeReturnedNumberOfItems : number ; } [] ; returnOrderNumber : string ; tracking ?: null | { trackingUrl ?: null | string ; waybill ?: null | string ; } [] ; warehouseId ?: null | number ; } ; }
application/json : { comment ?: null | string ; customerOrder : { orderId ?: number ; } ; goodsOwnerId : number ; inDate ?: null | string ; returnOrderHandlingComment ?: null | string ; returnOrderLines : { customerOrderLine : { orderLineId ?: number ; } ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnOrderRowNumber : string ; toBeReturnedNumberOfItems : number ; } [] ; returnOrderNumber : string ; tracking ?: null | { trackingUrl ?: null | string ; waybill ?: null | string ; } [] ; warehouseId ?: null | number ; }
Optional comment ?: null | string
customer Order : { orderId ?: number ; }
Optional order Id ?: number
goods Owner Id : number
Optional in Date ?: null | string
Optional return Order Handling Comment ?: null | string
return Order Lines : { customerOrderLine : { orderLineId ?: number ; } ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnOrderRowNumber : string ; toBeReturnedNumberOfItems : number ; } []
return Order Number : string
Optional tracking ?: null | { trackingUrl ?: null | string ; waybill ?: null | string ; } []
Optional warehouse Id ?: null | number
responses : { 200 : { content : { application/json : { message ?: null | string ; returnOrderId ?: null | number ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; returnOrderId ?: null | number ; } ; } ; }
content : { application/json : { message ?: null | string ; returnOrderId ?: null | number ; } ; }
application/json : { message ?: null | string ; returnOrderId ?: null | number ; }
Optional message ?: null | string
Optional return Order Id ?: null | number
/api/v1/return Orders/return Causes
/api/v1/return Orders/return Causes : { get : { parameters : { query : { goodsOwnerId : number ; } ; } ; responses : { 200 : { content : { application/json : { returnCauses ?: null | { code ?: null | string ; id ?: number ; isChangeCause ?: boolean ; isRemoveCause ?: boolean ; isReturnCommentMandatory ?: boolean ; name ?: null | string ; } [] ; } ; } ; } ; } ; } ; put : { requestBody : { content : { application/json : { code : string ; goodsOwnerId : number ; isChangeCause ?: null | boolean ; isRemoveCause ?: null | boolean ; isReturnCommentMandatory ?: null | boolean ; name : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; returnCauseId ?: null | number ; success ?: boolean ; } ; } ; } ; } ; } ; }
Type declaration
get : { parameters : { query : { goodsOwnerId : number ; } ; } ; responses : { 200 : { content : { application/json : { returnCauses ?: null | { code ?: null | string ; id ?: number ; isChangeCause ?: boolean ; isRemoveCause ?: boolean ; isReturnCommentMandatory ?: boolean ; name ?: null | string ; } [] ; } ; } ; } ; } ; }
parameters : { query : { goodsOwnerId : number ; } ; }
query : { goodsOwnerId : number ; }
responses : { 200 : { content : { application/json : { returnCauses ?: null | { code ?: null | string ; id ?: number ; isChangeCause ?: boolean ; isRemoveCause ?: boolean ; isReturnCommentMandatory ?: boolean ; name ?: null | string ; } [] ; } ; } ; } ; }
200 : { content : { application/json : { returnCauses ?: null | { code ?: null | string ; id ?: number ; isChangeCause ?: boolean ; isRemoveCause ?: boolean ; isReturnCommentMandatory ?: boolean ; name ?: null | string ; } [] ; } ; } ; }
content : { application/json : { returnCauses ?: null | { code ?: null | string ; id ?: number ; isChangeCause ?: boolean ; isRemoveCause ?: boolean ; isReturnCommentMandatory ?: boolean ; name ?: null | string ; } [] ; } ; }
application/json : { returnCauses ?: null | { code ?: null | string ; id ?: number ; isChangeCause ?: boolean ; isRemoveCause ?: boolean ; isReturnCommentMandatory ?: boolean ; name ?: null | string ; } [] ; }
Optional return Causes ?: null | { code ?: null | string ; id ?: number ; isChangeCause ?: boolean ; isRemoveCause ?: boolean ; isReturnCommentMandatory ?: boolean ; name ?: null | string ; } []
put : { requestBody : { content : { application/json : { code : string ; goodsOwnerId : number ; isChangeCause ?: null | boolean ; isRemoveCause ?: null | boolean ; isReturnCommentMandatory ?: null | boolean ; name : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; returnCauseId ?: null | number ; success ?: boolean ; } ; } ; } ; } ; }
request Body : { content : { application/json : { code : string ; goodsOwnerId : number ; isChangeCause ?: null | boolean ; isRemoveCause ?: null | boolean ; isReturnCommentMandatory ?: null | boolean ; name : string ; } ; } ; }
content : { application/json : { code : string ; goodsOwnerId : number ; isChangeCause ?: null | boolean ; isRemoveCause ?: null | boolean ; isReturnCommentMandatory ?: null | boolean ; name : string ; } ; }
application/json : { code : string ; goodsOwnerId : number ; isChangeCause ?: null | boolean ; isRemoveCause ?: null | boolean ; isReturnCommentMandatory ?: null | boolean ; name : string ; }
code : string
goods Owner Id : number
Optional is Change Cause ?: null | boolean
Optional is Remove Cause ?: null | boolean
Optional is Return Comment Mandatory ?: null | boolean
name : string
responses : { 200 : { content : { application/json : { message ?: null | string ; returnCauseId ?: null | number ; success ?: boolean ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; returnCauseId ?: null | number ; success ?: boolean ; } ; } ; }
content : { application/json : { message ?: null | string ; returnCauseId ?: null | number ; success ?: boolean ; } ; }
application/json : { message ?: null | string ; returnCauseId ?: null | number ; success ?: boolean ; }
Optional message ?: null | string
Optional return Cause Id ?: null | number
Optional success ?: boolean
/api/v1/return Orders/return Causes/{return Cause Id}
/api/v1/return Orders/return Causes/{return Cause Id} : { put : { parameters : { path : { returnCauseId : number ; } ; } ; requestBody : { content : { application/json : { code : string ; goodsOwnerId : number ; isChangeCause ?: null | boolean ; isRemoveCause ?: null | boolean ; isReturnCommentMandatory ?: null | boolean ; name : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; returnCauseId ?: null | number ; success ?: boolean ; } ; } ; } ; } ; } ; }
Type declaration
put : { parameters : { path : { returnCauseId : number ; } ; } ; requestBody : { content : { application/json : { code : string ; goodsOwnerId : number ; isChangeCause ?: null | boolean ; isRemoveCause ?: null | boolean ; isReturnCommentMandatory ?: null | boolean ; name : string ; } ; } ; } ; responses : { 200 : { content : { application/json : { message ?: null | string ; returnCauseId ?: null | number ; success ?: boolean ; } ; } ; } ; } ; }
parameters : { path : { returnCauseId : number ; } ; }
path : { returnCauseId : number ; }
request Body : { content : { application/json : { code : string ; goodsOwnerId : number ; isChangeCause ?: null | boolean ; isRemoveCause ?: null | boolean ; isReturnCommentMandatory ?: null | boolean ; name : string ; } ; } ; }
content : { application/json : { code : string ; goodsOwnerId : number ; isChangeCause ?: null | boolean ; isRemoveCause ?: null | boolean ; isReturnCommentMandatory ?: null | boolean ; name : string ; } ; }
application/json : { code : string ; goodsOwnerId : number ; isChangeCause ?: null | boolean ; isRemoveCause ?: null | boolean ; isReturnCommentMandatory ?: null | boolean ; name : string ; }
code : string
goods Owner Id : number
Optional is Change Cause ?: null | boolean
Optional is Remove Cause ?: null | boolean
Optional is Return Comment Mandatory ?: null | boolean
name : string
responses : { 200 : { content : { application/json : { message ?: null | string ; returnCauseId ?: null | number ; success ?: boolean ; } ; } ; } ; }
200 : { content : { application/json : { message ?: null | string ; returnCauseId ?: null | number ; success ?: boolean ; } ; } ; }
content : { application/json : { message ?: null | string ; returnCauseId ?: null | number ; success ?: boolean ; } ; }
application/json : { message ?: null | string ; returnCauseId ?: null | number ; success ?: boolean ; }
Optional message ?: null | string
Optional return Cause Id ?: null | number
Optional success ?: boolean
/api/v1/return Orders/statuses
/api/v1/return Orders/statuses : { get : { responses : { 200 : { content : { application/json : { returnOrderStatuses ?: null | { number ?: number ; text ?: null | string ; } [] ; } ; } ; } ; } ; } ; }
Type declaration
get : { responses : { 200 : { content : { application/json : { returnOrderStatuses ?: null | { number ?: number ; text ?: null | string ; } [] ; } ; } ; } ; } ; }
responses : { 200 : { content : { application/json : { returnOrderStatuses ?: null | { number ?: number ; text ?: null | string ; } [] ; } ; } ; } ; }
200 : { content : { application/json : { returnOrderStatuses ?: null | { number ?: number ; text ?: null | string ; } [] ; } ; } ; }
content : { application/json : { returnOrderStatuses ?: null | { number ?: number ; text ?: null | string ; } [] ; } ; }
application/json : { returnOrderStatuses ?: null | { number ?: number ; text ?: null | string ; } [] ; }
Optional return Order Statuses ?: null | { number ?: number ; text ?: null | string ; } []
/api/v1/return Orders/{return Order Id}
/api/v1/return Orders/{return Order Id} : { get : { parameters : { path : { returnOrderId : number ; } ; } ; responses : { 200 : { content : { application/json : { customerOrderInfo ?: { orderId ?: number ; orderNumber ?: null | string ; } ; returnOrderInfo ?: { comment ?: null | string ; inDate ?: null | string ; returnOrderHandlingComment ?: null | string ; returnOrderId ?: number ; returnOrderNumber ?: null | string ; returnOrderStatus ?: { number ?: number ; text ?: null | string ; } ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } ; returnOrderLines ?: null | { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; } ; customerOrderLine ?: { customerOrderRowNumber ?: null | string ; orderLineId ?: number ; } ; pickedNumberOfItems ?: number ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnOrderLineId ?: number ; returnOrderRowNumber ?: null | string ; returnedArticleItems ?: null | { articleItemCategory ?: { code ?: null | string ; name ?: null | string ; } ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batch ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; isReturnRemovedByInventory ?: boolean ; numberOfItems ?: number ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnComment ?: null | string ; returnTime ?: null | string ; serial ?: null | string ; volume ?: null | number ; weight ?: null | number ; } [] ; returnedNumberOfItems ?: number ; returnedRemovedByInventoryNumberOfItems ?: number ; toBeReturnedNumberOfItems ?: number ; } [] ; } ; } ; } ; } ; } ; }
Type declaration
get : { parameters : { path : { returnOrderId : number ; } ; } ; responses : { 200 : { content : { application/json : { customerOrderInfo ?: { orderId ?: number ; orderNumber ?: null | string ; } ; returnOrderInfo ?: { comment ?: null | string ; inDate ?: null | string ; returnOrderHandlingComment ?: null | string ; returnOrderId ?: number ; returnOrderNumber ?: null | string ; returnOrderStatus ?: { number ?: number ; text ?: null | string ; } ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } ; returnOrderLines ?: null | { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; } ; customerOrderLine ?: { customerOrderRowNumber ?: null | string ; orderLineId ?: number ; } ; pickedNumberOfItems ?: number ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnOrderLineId ?: number ; returnOrderRowNumber ?: null | string ; returnedArticleItems ?: null | { articleItemCategory ?: { code ?: null | string ; name ?: null | string ; } ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batch ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; isReturnRemovedByInventory ?: boolean ; numberOfItems ?: number ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnComment ?: null | string ; returnTime ?: null | string ; serial ?: null | string ; volume ?: null | number ; weight ?: null | number ; } [] ; returnedNumberOfItems ?: number ; returnedRemovedByInventoryNumberOfItems ?: number ; toBeReturnedNumberOfItems ?: number ; } [] ; } ; } ; } ; } ; }
parameters : { path : { returnOrderId : number ; } ; }
path : { returnOrderId : number ; }
responses : { 200 : { content : { application/json : { customerOrderInfo ?: { orderId ?: number ; orderNumber ?: null | string ; } ; returnOrderInfo ?: { comment ?: null | string ; inDate ?: null | string ; returnOrderHandlingComment ?: null | string ; returnOrderId ?: number ; returnOrderNumber ?: null | string ; returnOrderStatus ?: { number ?: number ; text ?: null | string ; } ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } ; returnOrderLines ?: null | { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; } ; customerOrderLine ?: { customerOrderRowNumber ?: null | string ; orderLineId ?: number ; } ; pickedNumberOfItems ?: number ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnOrderLineId ?: number ; returnOrderRowNumber ?: null | string ; returnedArticleItems ?: null | { articleItemCategory ?: { code ?: null | string ; name ?: null | string ; } ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batch ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; isReturnRemovedByInventory ?: boolean ; numberOfItems ?: number ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnComment ?: null | string ; returnTime ?: null | string ; serial ?: null | string ; volume ?: null | number ; weight ?: null | number ; } [] ; returnedNumberOfItems ?: number ; returnedRemovedByInventoryNumberOfItems ?: number ; toBeReturnedNumberOfItems ?: number ; } [] ; } ; } ; } ; }
200 : { content : { application/json : { customerOrderInfo ?: { orderId ?: number ; orderNumber ?: null | string ; } ; returnOrderInfo ?: { comment ?: null | string ; inDate ?: null | string ; returnOrderHandlingComment ?: null | string ; returnOrderId ?: number ; returnOrderNumber ?: null | string ; returnOrderStatus ?: { number ?: number ; text ?: null | string ; } ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } ; returnOrderLines ?: null | { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; } ; customerOrderLine ?: { customerOrderRowNumber ?: null | string ; orderLineId ?: number ; } ; pickedNumberOfItems ?: number ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnOrderLineId ?: number ; returnOrderRowNumber ?: null | string ; returnedArticleItems ?: null | { articleItemCategory ?: { code ?: null | string ; name ?: null | string ; } ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batch ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; isReturnRemovedByInventory ?: boolean ; numberOfItems ?: number ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnComment ?: null | string ; returnTime ?: null | string ; serial ?: null | string ; volume ?: null | number ; weight ?: null | number ; } [] ; returnedNumberOfItems ?: number ; returnedRemovedByInventoryNumberOfItems ?: number ; toBeReturnedNumberOfItems ?: number ; } [] ; } ; } ; }
content : { application/json : { customerOrderInfo ?: { orderId ?: number ; orderNumber ?: null | string ; } ; returnOrderInfo ?: { comment ?: null | string ; inDate ?: null | string ; returnOrderHandlingComment ?: null | string ; returnOrderId ?: number ; returnOrderNumber ?: null | string ; returnOrderStatus ?: { number ?: number ; text ?: null | string ; } ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } ; returnOrderLines ?: null | { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; } ; customerOrderLine ?: { customerOrderRowNumber ?: null | string ; orderLineId ?: number ; } ; pickedNumberOfItems ?: number ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnOrderLineId ?: number ; returnOrderRowNumber ?: null | string ; returnedArticleItems ?: null | { articleItemCategory ?: { code ?: null | string ; name ?: null | string ; } ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batch ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; isReturnRemovedByInventory ?: boolean ; numberOfItems ?: number ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnComment ?: null | string ; returnTime ?: null | string ; serial ?: null | string ; volume ?: null | number ; weight ?: null | number ; } [] ; returnedNumberOfItems ?: number ; returnedRemovedByInventoryNumberOfItems ?: number ; toBeReturnedNumberOfItems ?: number ; } [] ; } ; }
application/json : { customerOrderInfo ?: { orderId ?: number ; orderNumber ?: null | string ; } ; returnOrderInfo ?: { comment ?: null | string ; inDate ?: null | string ; returnOrderHandlingComment ?: null | string ; returnOrderId ?: number ; returnOrderNumber ?: null | string ; returnOrderStatus ?: { number ?: number ; text ?: null | string ; } ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; } ; returnOrderLines ?: null | { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; } ; customerOrderLine ?: { customerOrderRowNumber ?: null | string ; orderLineId ?: number ; } ; pickedNumberOfItems ?: number ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnOrderLineId ?: number ; returnOrderRowNumber ?: null | string ; returnedArticleItems ?: null | { articleItemCategory ?: { code ?: null | string ; name ?: null | string ; } ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batch ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; isReturnRemovedByInventory ?: boolean ; numberOfItems ?: number ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnComment ?: null | string ; returnTime ?: null | string ; serial ?: null | string ; volume ?: null | number ; weight ?: null | number ; } [] ; returnedNumberOfItems ?: number ; returnedRemovedByInventoryNumberOfItems ?: number ; toBeReturnedNumberOfItems ?: number ; } [] ; }
Optional customer Order Info ?: { orderId ?: number ; orderNumber ?: null | string ; }
Optional order Id ?: number
Optional order Number ?: null | string
Optional return Order Info ?: { comment ?: null | string ; inDate ?: null | string ; returnOrderHandlingComment ?: null | string ; returnOrderId ?: number ; returnOrderNumber ?: null | string ; returnOrderStatus ?: { number ?: number ; text ?: null | string ; } ; warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; } ; }
Optional comment ?: null | string
Optional in Date ?: null | string
Optional return Order Handling Comment ?: null | string
Optional return Order Id ?: number
Optional return Order Number ?: null | string
Optional return Order Status ?: { number ?: number ; text ?: null | string ; }
Optional number ?: number
Optional text ?: null | string
Optional warehouse ?: { code ?: null | string ; id ?: number ; name ?: null | string ; }
Optional code ?: null | string
Optional id ?: number
Optional name ?: null | string
Optional return Order Lines ?: null | { article ?: { articleName ?: null | string ; articleNumber ?: null | string ; articleSystemId ?: number ; } ; customerOrderLine ?: { customerOrderRowNumber ?: null | string ; orderLineId ?: number ; } ; pickedNumberOfItems ?: number ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnOrderLineId ?: number ; returnOrderRowNumber ?: null | string ; returnedArticleItems ?: null | { articleItemCategory ?: { code ?: null | string ; name ?: null | string ; } ; articleItemStatus ?: { code ?: null | string ; name ?: null | string ; } ; batch ?: null | string ; comment ?: null | string ; container ?: null | string ; expiryDate ?: null | string ; isReturnRemovedByInventory ?: boolean ; numberOfItems ?: number ; returnCause ?: { code ?: null | string ; name ?: null | string ; } ; returnComment ?: null | string ; returnTime ?: null | string ; serial ?: null | string ; volume ?: null | number ; weight ?: null | number ; } [] ; returnedNumberOfItems ?: number ; returnedRemovedByInventoryNumberOfItems ?: number ; toBeReturnedNumberOfItems ?: number ; } []
/api/v1/transporter Contracts
/api/v1/transporter Contracts : { get : { parameters : { query : { goodsOwnerId : number ; } ; } ; responses : { 200 : { content : { application/json : null | { ediCode ?: null | string ; transporterCode ?: null | string ; transporterName ?: null | string ; transporterServiceCode ?: null | string ; transporterServices ?: null | { transporterServiceCode ?: null | string ; transporterServiceName ?: null | string ; } [] ; } [] ; } ; } ; } ; } ; }
Type declaration
get : { parameters : { query : { goodsOwnerId : number ; } ; } ; responses : { 200 : { content : { application/json : null | { ediCode ?: null | string ; transporterCode ?: null | string ; transporterName ?: null | string ; transporterServiceCode ?: null | string ; transporterServices ?: null | { transporterServiceCode ?: null | string ; transporterServiceName ?: null | string ; } [] ; } [] ; } ; } ; } ; }
parameters : { query : { goodsOwnerId : number ; } ; }
query : { goodsOwnerId : number ; }
responses : { 200 : { content : { application/json : null | { ediCode ?: null | string ; transporterCode ?: null | string ; transporterName ?: null | string ; transporterServiceCode ?: null | string ; transporterServices ?: null | { transporterServiceCode ?: null | string ; transporterServiceName ?: null | string ; } [] ; } [] ; } ; } ; }
200 : { content : { application/json : null | { ediCode ?: null | string ; transporterCode ?: null | string ; transporterName ?: null | string ; transporterServiceCode ?: null | string ; transporterServices ?: null | { transporterServiceCode ?: null | string ; transporterServiceName ?: null | string ; } [] ; } [] ; } ; }
content : { application/json : null | { ediCode ?: null | string ; transporterCode ?: null | string ; transporterName ?: null | string ; transporterServiceCode ?: null | string ; transporterServices ?: null | { transporterServiceCode ?: null | string ; transporterServiceName ?: null | string ; } [] ; } [] ; }
application/json : null | { ediCode ?: null | string ; transporterCode ?: null | string ; transporterName ?: null | string ; transporterServiceCode ?: null | string ; transporterServices ?: null | { transporterServiceCode ?: null | string ; transporterServiceName ?: null | string ; } [] ; } []
/api/v1/warehouses
/api/v1/warehouses : { get : { responses : { 200 : { content : { application/json : null | { address ?: { address1 ?: null | string ; address2 ?: null | string ; address3 ?: null | string ; addressFreeText1 ?: null | string ; addressFreeText2 ?: null | string ; city ?: null | string ; countryCode ?: null | string ; countryStateCode ?: null | string ; deliveryInstruction ?: null | string ; emailNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; name ?: null | string ; postCode ?: null | string ; smsNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; telephoneNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; } ; code ?: null | string ; id ?: number ; name ?: null | string ; } [] ; } ; } ; } ; } ; }
Type declaration
get : { responses : { 200 : { content : { application/json : null | { address ?: { address1 ?: null | string ; address2 ?: null | string ; address3 ?: null | string ; addressFreeText1 ?: null | string ; addressFreeText2 ?: null | string ; city ?: null | string ; countryCode ?: null | string ; countryStateCode ?: null | string ; deliveryInstruction ?: null | string ; emailNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; name ?: null | string ; postCode ?: null | string ; smsNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; telephoneNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; } ; code ?: null | string ; id ?: number ; name ?: null | string ; } [] ; } ; } ; } ; }
responses : { 200 : { content : { application/json : null | { address ?: { address1 ?: null | string ; address2 ?: null | string ; address3 ?: null | string ; addressFreeText1 ?: null | string ; addressFreeText2 ?: null | string ; city ?: null | string ; countryCode ?: null | string ; countryStateCode ?: null | string ; deliveryInstruction ?: null | string ; emailNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; name ?: null | string ; postCode ?: null | string ; smsNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; telephoneNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; } ; code ?: null | string ; id ?: number ; name ?: null | string ; } [] ; } ; } ; }
200 : { content : { application/json : null | { address ?: { address1 ?: null | string ; address2 ?: null | string ; address3 ?: null | string ; addressFreeText1 ?: null | string ; addressFreeText2 ?: null | string ; city ?: null | string ; countryCode ?: null | string ; countryStateCode ?: null | string ; deliveryInstruction ?: null | string ; emailNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; name ?: null | string ; postCode ?: null | string ; smsNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; telephoneNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; } ; code ?: null | string ; id ?: number ; name ?: null | string ; } [] ; } ; }
content : { application/json : null | { address ?: { address1 ?: null | string ; address2 ?: null | string ; address3 ?: null | string ; addressFreeText1 ?: null | string ; addressFreeText2 ?: null | string ; city ?: null | string ; countryCode ?: null | string ; countryStateCode ?: null | string ; deliveryInstruction ?: null | string ; emailNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; name ?: null | string ; postCode ?: null | string ; smsNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; telephoneNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; } ; code ?: null | string ; id ?: number ; name ?: null | string ; } [] ; }
application/json : null | { address ?: { address1 ?: null | string ; address2 ?: null | string ; address3 ?: null | string ; addressFreeText1 ?: null | string ; addressFreeText2 ?: null | string ; city ?: null | string ; countryCode ?: null | string ; countryStateCode ?: null | string ; deliveryInstruction ?: null | string ; emailNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; name ?: null | string ; postCode ?: null | string ; smsNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; telephoneNotification ?: { toBeNotified ?: boolean ; value ?: null | string ; } ; } ; code ?: null | string ; id ?: number ; name ?: null | string ; } []
/api/v1/warehouses/locations/types
/api/v1/warehouses/locations/types : { get : { responses : { 200 : { content : { application/json : null | { code ?: null | string ; id ?: number ; name ?: null | string ; } [] ; } ; } ; } ; } ; }
Type declaration
get : { responses : { 200 : { content : { application/json : null | { code ?: null | string ; id ?: number ; name ?: null | string ; } [] ; } ; } ; } ; }
responses : { 200 : { content : { application/json : null | { code ?: null | string ; id ?: number ; name ?: null | string ; } [] ; } ; } ; }
200 : { content : { application/json : null | { code ?: null | string ; id ?: number ; name ?: null | string ; } [] ; } ; }
content : { application/json : null | { code ?: null | string ; id ?: number ; name ?: null | string ; } [] ; }
application/json : null | { code ?: null | string ; id ?: number ; name ?: null | string ; } []
/api/v1/warehouses/{warehouse Id}/zones
/api/v1/warehouses/{warehouse Id}/zones : { get : { parameters : { path : { warehouseId : number ; } ; } ; responses : { 200 : { content : { application/json : null | { aisles ?: null | { id ?: number ; locations ?: null | { barcode ?: null | string ; id ?: number ; isLocked ?: boolean ; isLockedForSale ?: boolean ; isPickingLocation ?: boolean ; locationTypeId ?: null | number ; name ?: null | string ; pickingPriority ?: number ; position ?: { x ?: null | number ; y ?: null | number ; z ?: null | number ; } ; } [] ; name ?: null | string ; position ?: { x ?: null | number ; y ?: null | number ; } ; } [] ; id ?: number ; name ?: null | string ; position ?: { x ?: null | number ; y ?: null | number ; } ; } [] ; } ; } ; } ; } ; }
Type declaration
get : { parameters : { path : { warehouseId : number ; } ; } ; responses : { 200 : { content : { application/json : null | { aisles ?: null | { id ?: number ; locations ?: null | { barcode ?: null | string ; id ?: number ; isLocked ?: boolean ; isLockedForSale ?: boolean ; isPickingLocation ?: boolean ; locationTypeId ?: null | number ; name ?: null | string ; pickingPriority ?: number ; position ?: { x ?: null | number ; y ?: null | number ; z ?: null | number ; } ; } [] ; name ?: null | string ; position ?: { x ?: null | number ; y ?: null | number ; } ; } [] ; id ?: number ; name ?: null | string ; position ?: { x ?: null | number ; y ?: null | number ; } ; } [] ; } ; } ; } ; }
parameters : { path : { warehouseId : number ; } ; }
path : { warehouseId : number ; }
responses : { 200 : { content : { application/json : null | { aisles ?: null | { id ?: number ; locations ?: null | { barcode ?: null | string ; id ?: number ; isLocked ?: boolean ; isLockedForSale ?: boolean ; isPickingLocation ?: boolean ; locationTypeId ?: null | number ; name ?: null | string ; pickingPriority ?: number ; position ?: { x ?: null | number ; y ?: null | number ; z ?: null | number ; } ; } [] ; name ?: null | string ; position ?: { x ?: null | number ; y ?: null | number ; } ; } [] ; id ?: number ; name ?: null | string ; position ?: { x ?: null | number ; y ?: null | number ; } ; } [] ; } ; } ; }
200 : { content : { application/json : null | { aisles ?: null | { id ?: number ; locations ?: null | { barcode ?: null | string ; id ?: number ; isLocked ?: boolean ; isLockedForSale ?: boolean ; isPickingLocation ?: boolean ; locationTypeId ?: null | number ; name ?: null | string ; pickingPriority ?: number ; position ?: { x ?: null | number ; y ?: null | number ; z ?: null | number ; } ; } [] ; name ?: null | string ; position ?: { x ?: null | number ; y ?: null | number ; } ; } [] ; id ?: number ; name ?: null | string ; position ?: { x ?: null | number ; y ?: null | number ; } ; } [] ; } ; }
content : { application/json : null | { aisles ?: null | { id ?: number ; locations ?: null | { barcode ?: null | string ; id ?: number ; isLocked ?: boolean ; isLockedForSale ?: boolean ; isPickingLocation ?: boolean ; locationTypeId ?: null | number ; name ?: null | string ; pickingPriority ?: number ; position ?: { x ?: null | number ; y ?: null | number ; z ?: null | number ; } ; } [] ; name ?: null | string ; position ?: { x ?: null | number ; y ?: null | number ; } ; } [] ; id ?: number ; name ?: null | string ; position ?: { x ?: null | number ; y ?: null | number ; } ; } [] ; }
application/json : null | { aisles ?: null | { id ?: number ; locations ?: null | { barcode ?: null | string ; id ?: number ; isLocked ?: boolean ; isLockedForSale ?: boolean ; isPickingLocation ?: boolean ; locationTypeId ?: null | number ; name ?: null | string ; pickingPriority ?: number ; position ?: { x ?: null | number ; y ?: null | number ; z ?: null | number ; } ; } [] ; name ?: null | string ; position ?: { x ?: null | number ; y ?: null | number ; } ; } [] ; id ?: number ; name ?: null | string ; position ?: { x ?: null | number ; y ?: null | number ; } ; } []
This file was auto-generated by openapi-typescript. Do not make direct changes to the file.